limarka 0.5.5 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -2
- data/CONTRIBUTING.md +65 -10
- data/README.md +73 -28
- data/lib/limarka/cli.rb +44 -0
- data/lib/limarka/version.rb +1 -1
- data/limarka.gemspec +1 -2
- metadata +16 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 16a9d7a5810b1f9d958f7155b4a77abfcf851d92
|
|
4
|
+
data.tar.gz: 96ac609d60ab0a8c8fea77aa355606f9bc8738bd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: abbb83201f069d874314516ae9f926ab48effcb12f22c73ff8e18f7dc94edce6fdd203b6e623fe518df7d3bb233e4c6a11cc0470b7a84dbd1aa9a8797a7c3330
|
|
7
|
+
data.tar.gz: 8bfdb239e802beb978a0a324bb2480705794253b3dad9ad99dac886cfe573544274f13c852347801b35e9f76a26700fef8e458bbe0acdc142ae1559aa8d5c8f2
|
data/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,23 @@
|
|
|
1
1
|
# Change Log
|
|
2
2
|
|
|
3
|
-
## [v0.
|
|
4
|
-
[Full Changelog](https://github.com/abntex/limarka/compare/v0.5.
|
|
3
|
+
## [v0.6.0](https://github.com/abntex/limarka/tree/v0.6.0) (2016-12-27)
|
|
4
|
+
[Full Changelog](https://github.com/abntex/limarka/compare/v0.5.5...v0.6.0)
|
|
5
|
+
|
|
6
|
+
**Melhorias implementadas:**
|
|
7
|
+
|
|
8
|
+
- Criação de um logo para o projeto [\#102](https://github.com/abntex/limarka/issues/102)
|
|
9
|
+
- Inclusão de menu interativo [\#100](https://github.com/abntex/limarka/issues/100)
|
|
10
|
+
|
|
11
|
+
## [v0.5.5](https://github.com/abntex/limarka/tree/v0.5.5) (2016-12-19)
|
|
12
|
+
[Full Changelog](https://github.com/abntex/limarka/compare/v0.5.4...v0.5.5)
|
|
5
13
|
|
|
6
14
|
**Melhorias implementadas:**
|
|
7
15
|
|
|
8
16
|
- Remover dependência de execução pdftotext [\#97](https://github.com/abntex/limarka/issues/97)
|
|
17
|
+
- Tornar compatível com o Windows [\#87](https://github.com/abntex/limarka/issues/87)
|
|
18
|
+
|
|
19
|
+
## [v0.5.4](https://github.com/abntex/limarka/tree/v0.5.4) (2016-12-19)
|
|
20
|
+
[Full Changelog](https://github.com/abntex/limarka/compare/v0.5.3...v0.5.4)
|
|
9
21
|
|
|
10
22
|
**Bugs corrigidos:**
|
|
11
23
|
|
data/CONTRIBUTING.md
CHANGED
|
@@ -1,14 +1,61 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Experimento
|
|
2
2
|
|
|
3
3
|
No momento, as maiores contribuições são: utilizar a ferramenta, [realizar o experimento]
|
|
4
4
|
e [divulgá-la](https://github.com/abntex/limarka/wiki/Imprensa).
|
|
5
5
|
|
|
6
6
|
[realizar o experimento]: https://github.com/abntex/limarka/wiki/Experimentos
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
acordo com o [código de conduda].
|
|
8
|
+
O projeto tem como origem uma pesquisa científica (em andamento) sobre utilização de linguagem de marcação de texto para elaboração de monografias.
|
|
10
9
|
|
|
11
|
-
[
|
|
10
|
+
- [Realize o experimento de utilização](https://github.com/abntex/limarka/wiki/Experimentos)
|
|
11
|
+
|
|
12
|
+
# Professor
|
|
13
|
+
|
|
14
|
+
Como professor você pode contribuir com o limarka divulgando-o e ofertando o limarka como uma opção para seus alunos realizarem tarefas.
|
|
15
|
+
|
|
16
|
+
- Ao solicitar relatórios de atividades aos alunos, sugira a utilização do limarka. Embora o limarka tenha o propósito de produzir trabalhos de conclusão de curso, ele pode ser facilmente utilizado para elaboração de relatórios.
|
|
17
|
+
|
|
18
|
+
- Sugira seus orientandos experimentarem o limarka. O limarka é gratuito e livre, pode ser utilizado no Linux, OS X e Windows. Não recomendamos utilizar o limarka em trabalhos de conclusão que exigam bastante fórmulas, teoremas ou provas. Os editores Latex oferecem melhor suporte para isso.
|
|
19
|
+
|
|
20
|
+
- Atualize sua página pessoal/institucional adicionando uma [matéria ou link sobre o limarka](https://github.com/abntex/limarka/wiki/Imprensa). Seus alunos e outras pessoas poderão conhecer a ferramenta dessa forma.
|
|
21
|
+
|
|
22
|
+
- 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. O momento ideal para apresentar aos alunos a ferramenta são nas aulas de Metodologia. Por enquanto o foco da ferramenta são trabalho de conclusão, mas em breve também será possível realizar artigos.
|
|
23
|
+
|
|
24
|
+
- Divulgue um notícia sobre o limarka nas listas de professores ou alunos. O público alvo da ferramenta são os estudantes, essas listas propocionam encontrá-los.
|
|
25
|
+
|
|
26
|
+
- Recomende a veiculação de uma matéria sobre o limarka na agência de noticias de sua instituição. As agências de notícias das instituições são um ótimo meio para divulgação, verifique como contactar agência e recomende uma matéria para ser veiculada.
|
|
27
|
+
|
|
28
|
+
- Clique na estrela [no repositório do projeto](https://github.com/abntex/limarka) (equivale a um *like*) no github.
|
|
29
|
+
|
|
30
|
+
# Estudante
|
|
31
|
+
|
|
32
|
+
- Utilize o limarka para elaboração de relatórios
|
|
33
|
+
- Participe do [experimente de uso da ferramenta](https://github.com/abntex/limarka/wiki/Experimentos) - NECESSITA-SE URGENTEMENTE!
|
|
34
|
+
- Compartilhe alguma notícia do limarka em suas redes sociais ou lista de alunos ou de laboratórios
|
|
35
|
+
- Escreva seu trabalho de conclusão ou sua proposta/projeto com o limarka e compartilhe sua experiência
|
|
36
|
+
- Clique na estrela [no repositório do projeto](https://github.com/abntex/limarka) (equivale a um *like*) no github.
|
|
37
|
+
|
|
38
|
+
# Designer
|
|
39
|
+
|
|
40
|
+
- [Precisamos de ajuda para criar um logotipo para o projeto](https://github.com/abntex/limarka/issues/102).
|
|
41
|
+
|
|
42
|
+
# Usuário Latex
|
|
43
|
+
|
|
44
|
+
TODO.
|
|
45
|
+
|
|
46
|
+
# Desenvolvedor Ruby
|
|
47
|
+
|
|
48
|
+
Deseja participar do desenvolvimento do limarka? Considere os [issues marcados com o label help needed](https://github.com/abntex/limarka/labels/help%20wanted) como um convite para contribuir conosco.
|
|
49
|
+
|
|
50
|
+
Correção de bugs e implementação de novas funcionalidades através de Pull requests são sempre bem vindos.
|
|
51
|
+
|
|
52
|
+
Ao participar desse projeto você está de acordo com o [código de conduda].
|
|
53
|
+
|
|
54
|
+
[código de conduda]: https://github.com/abntex/limarka/blob/master/CODE_OF_CONDUCT.md
|
|
55
|
+
|
|
56
|
+
## Implementando uma nova funcionalidade
|
|
57
|
+
|
|
58
|
+
[Crie um issue](https://github.com/abntex/limarka/issues/new) descrevendo a nova funcionalidade.
|
|
12
59
|
|
|
13
60
|
Realize um fork no projeto, depois faça o clone do seu fork:
|
|
14
61
|
|
|
@@ -26,16 +73,24 @@ Crie uma branch a partir da master para sua funcionalidade:
|
|
|
26
73
|
|
|
27
74
|
git checkout -b minha-funcionalidade
|
|
28
75
|
|
|
29
|
-
Realize as alterações. Adicione testes para as suas mudanças. Faça os testes passarem:
|
|
76
|
+
Realize as alterações. Adicione testes (opicional, mas desejado) para as suas mudanças. Faça os testes passarem:
|
|
30
77
|
|
|
31
78
|
rake
|
|
79
|
+
git add arquivo-modificado1 arquivo-modificado2
|
|
80
|
+
git commit
|
|
81
|
+
|
|
82
|
+
Se existir um Issue referente a funcionalidade implementada [utilize o número do issue na mensagem de commit](https://help.github.com/articles/closing-issues-via-commit-messages/) para manter rastreabilidade.
|
|
83
|
+
|
|
84
|
+
Faça um Push para o seu fork:
|
|
85
|
+
|
|
86
|
+
git push origin minha-funcionalidade
|
|
87
|
+
|
|
88
|
+
[Submeta um pull request](https://github.com/abntex/limarka/compare/). Altere o título do issue/PR para o texto que deseja ser adicionado ao [CHANGELOG](https://github.com/abntex/limarka/blob/master/CHANGELOG.md)
|
|
32
89
|
|
|
33
|
-
|
|
90
|
+
## Desenvolvimento
|
|
34
91
|
|
|
35
|
-
|
|
36
|
-
- Altere o título do issue para o texto que deseja ser adicionado ao [CHANGELOG](https://github.com/abntex/limarka/blob/master/CHANGELOG.md)
|
|
92
|
+
Talvez você deseje consulta a página sobre o [desenvolvimento da ferramenta](https://github.com/abntex/limarka/wiki/Desenvolvimento).
|
|
37
93
|
|
|
38
|
-
|
|
94
|
+
# Participando no fórum
|
|
39
95
|
|
|
40
96
|
Você também pode participar do [fórum de discussão do limarka](https://groups.google.com/forum/#!forum/limarka).
|
|
41
|
-
[pr]: https://github.com/abntex/limarka/compare/
|
data/README.md
CHANGED
|
@@ -1,19 +1,82 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://badge.fury.io/rb/limarka)
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
- [Fórum de usuários no google groups](https://groups.google.com/forum/#!forum/limarka)
|
|
5
|
+
Olá! Bem vindo ao limarka!
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
<!-- Show what you're doing, for who, and why. -->
|
|
8
|
+
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# Especificidades do limarka
|
|
14
|
+
|
|
15
|
+
<!-- Explain what makes your project special, useful, exciting! -->
|
|
16
|
+
|
|
17
|
+
* Exige conhecimentos mínimos sobre as Normas da ABNT
|
|
18
|
+
* Utiliza modelo com estilos pré-configurados com as normas e de fácil utilização
|
|
19
|
+
* Utiliza sistema para gerenciamento de citações e elaboração das referências automaticamente
|
|
20
|
+
* Gera o sumário automaticamente, sem esforço adicional
|
|
21
|
+
* Permite a escrita do trabalho em arquivos somente texto, utilizando Markdown
|
|
22
|
+
* As configurações são realizadas em um arquivo de formulário em PDF
|
|
23
|
+
|
|
24
|
+
# Como iniciar utilização
|
|
25
|
+
|
|
26
|
+
<!-- Show how to get started using or contribution to the project -->
|
|
27
|
+
|
|
28
|
+
- [Veja se o visual do PDF gerado com a ferramenta lhe satisfaz](https://github.com/abntex/trabalho-academico-limarka/releases/download/v0.2.0/xxx-Monografia-projeto.pdf)
|
|
29
|
+
- [Para começar a utilizar a ferramenta siga as instruções no wiki do projeto](https://github.com/abntex/limarka/wiki)
|
|
30
|
+
|
|
31
|
+
# Contribuindo com o projeto
|
|
32
|
+
|
|
33
|
+
<!-- State what resources and contributions you're looking for -->
|
|
34
|
+
|
|
35
|
+
Veja como é fácil contribuir!
|
|
36
|
+
|
|
37
|
+
## Professor
|
|
38
|
+
|
|
39
|
+
- Atualize sua página pessoal/institucional adicionando uma [matéria ou link sobre o limarka](https://github.com/abntex/limarka/wiki/Imprensa)
|
|
40
|
+
- 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.
|
|
41
|
+
- Ao solicitar relatórios de atividades aos alunos, sugira a utilização do limarka.
|
|
42
|
+
- Divulgue um notícia sobre o limarka nas listas de professores ou alunos.
|
|
43
|
+
- Recomende a veiculação de uma matéria sobre o limarka na agência de noticias de sua instituição.
|
|
44
|
+
- Sugira seus orientandos experimentarem o limarka.
|
|
45
|
+
- Clique na estrela no repositório do projeto (equivale a um *like*)
|
|
46
|
+
|
|
47
|
+
## Estudante
|
|
48
|
+
|
|
49
|
+
- Utilize o limarka para elaboração de relatórios
|
|
50
|
+
- Participe do [experimente de uso da ferramenta](https://github.com/abntex/limarka/wiki/Experimentos) - NECESSITA-SE URGENTEMENTE!
|
|
51
|
+
- Compartilhe alguma notícia do limarka em suas redes sociais ou lista de alunos
|
|
52
|
+
- Escreva seu trabalho de conclusão com o limarka e compartilhe sua experiência
|
|
53
|
+
- Clique na estrela no repositório do projeto (equivale a um *like*)
|
|
9
54
|
|
|
10
|
-
|
|
55
|
+
## Usuário Latex
|
|
11
56
|
|
|
12
|
-
|
|
57
|
+
- Auxilie na criação de templates latex customizados para as instituições
|
|
13
58
|
|
|
14
|
-
|
|
59
|
+
## Desenvolvedor Ruby
|
|
15
60
|
|
|
16
|
-
|
|
61
|
+
- [Escolha uma das funcionalidades para implementar](https://github.com/abntex/limarka/issues)
|
|
62
|
+
- Notifique ou corrija um Bug
|
|
63
|
+
|
|
64
|
+
## Todas as formas de contribuição
|
|
65
|
+
|
|
66
|
+
Consulte o arquivo [CONTRIBUTING.md](CONTRIBUTING.md) para verificar todas as formas de contribuições.
|
|
67
|
+
|
|
68
|
+
<!-- Point to other key resources, such as a contributing.md file and a roadmap. -->
|
|
69
|
+
|
|
70
|
+
# Links
|
|
71
|
+
|
|
72
|
+
- A documentação do limarka será mantida no [wiki do projeto](https://github.com/abntex/limarka/wiki).
|
|
73
|
+
- [Vídeos](https://www.youtube.com/playlist?list=PLTnAY6TvPRKK6OgGYy3UA0oFdfCfRZesY) -- recomendo assistir em velocidade rápida
|
|
74
|
+
- [Convite para realização de experimento de utilização](https://github.com/abntex/limarka/wiki/Experimentos)
|
|
75
|
+
- [Fórum de usuários no google groups](https://groups.google.com/forum/#!forum/limarka)
|
|
76
|
+
|
|
77
|
+
# Por que escrever em Markdown em vez de Latex?
|
|
78
|
+
|
|
79
|
+
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?
|
|
17
80
|
|
|
18
81
|
Com o limarka você agora possui outra alternativa de investimento: *aprender Markdown* (que é bastante simples).
|
|
19
82
|
|
|
@@ -47,24 +110,6 @@ O limarka converte os textos produzidos em Markdown para LaTeX, utilizando os mo
|
|
|
47
110
|
- Facilidade em edição ou personalização de templates;
|
|
48
111
|
- Facilidade de obter suporte ao código Latex gerado (compatível com o estilo do abnTeX2);
|
|
49
112
|
|
|
50
|
-
# Documentação
|
|
51
|
-
|
|
52
|
-
A documentação do limarka será mantida no [wiki do projeto](https://github.com/abntex/limarka/wiki).
|
|
53
|
-
|
|
54
|
-
- [Vídeos](https://www.youtube.com/playlist?list=PLTnAY6TvPRKK6OgGYy3UA0oFdfCfRZesY) -- recomendo assistir em velocidade rápida
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
# Contribua participando da pesquisa sobre o limarka
|
|
58
|
-
|
|
59
|
-
O projeto tem como origem uma pesquisa científica (em andamento) sobre utilização de linguagem de marcação de texto para elaboração de monografias.
|
|
60
|
-
|
|
61
|
-
- [Realize o experimento de utilização](https://github.com/abntex/limarka/wiki/Experimentos)
|
|
62
|
-
- [Deseja contribuir com o desenvolvimento?](https://github.com/abntex/limarka/wiki/Desenvolvimento)
|
|
63
|
-
|
|
64
|
-
# Contributing
|
|
65
|
-
|
|
66
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/abntex/limarka. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
67
|
-
|
|
68
113
|
# License
|
|
69
114
|
|
|
70
|
-
|
|
115
|
+
Esse gem é disponibilizado como software livre através da [Licença MIT](http://opensource.org/licenses/MIT).
|
data/lib/limarka/cli.rb
CHANGED
|
@@ -9,6 +9,7 @@ require 'limarka/configuracao'
|
|
|
9
9
|
require 'limarka/ref'
|
|
10
10
|
require 'limarka/conversor'
|
|
11
11
|
require 'clipboard'
|
|
12
|
+
require 'terminal-table'
|
|
12
13
|
|
|
13
14
|
module Limarka
|
|
14
15
|
|
|
@@ -247,6 +248,49 @@ TEX
|
|
|
247
248
|
puts tex
|
|
248
249
|
end
|
|
249
250
|
|
|
251
|
+
desc "menu", "Inicia um menu interativo, aceita TAB para autocompletar."
|
|
252
|
+
def menu
|
|
253
|
+
table = Terminal::Table.new :title => "Menu interativo - limarka v#{Limarka::VERSION}\n#{Dir.pwd}", :headings => ['Comando', 'Descrição'] do |t|
|
|
254
|
+
t << ["exec", "Executa o limarka."]
|
|
255
|
+
t << ["figura","Imprime código para adição de Figura."]
|
|
256
|
+
t << ["tabela","Imprime código para adição de Tabela."]
|
|
257
|
+
t << ["cronograma","Imprime código para inclusão de Cronograma."]
|
|
258
|
+
t << ["rascunho","Executa o limarka lendo de rascunho.md"]
|
|
259
|
+
t << ["web","Imprime o endereço da documentação online."]
|
|
260
|
+
t << ["menu","Imprime esse menu."]
|
|
261
|
+
t << ["sair","Termina o menu interativo."]
|
|
262
|
+
end
|
|
263
|
+
puts table
|
|
264
|
+
sair = false
|
|
265
|
+
until sair do
|
|
266
|
+
cmd = ask("?", :limited_to => ["exec", "figura", "tabela", "cronograma","rascunho","web","menu","sair"])
|
|
267
|
+
case cmd
|
|
268
|
+
when "sair"
|
|
269
|
+
sair = true
|
|
270
|
+
when "menu"
|
|
271
|
+
puts table
|
|
272
|
+
when "exec"
|
|
273
|
+
system "limarka","exec"
|
|
274
|
+
when "web"
|
|
275
|
+
puts "https://github.com/abntex/limarka/wiki"
|
|
276
|
+
puts ""
|
|
277
|
+
when "figura"
|
|
278
|
+
system "limarka", "fig","-i"
|
|
279
|
+
when "tabela"
|
|
280
|
+
system "limarka", "tab"
|
|
281
|
+
when "cronograma"
|
|
282
|
+
system "limarka", "cronograma"
|
|
283
|
+
when "rascunho"
|
|
284
|
+
system "limarka", "exec", "--rascunho=rascunho.md"
|
|
285
|
+
else
|
|
286
|
+
"You gave me #{cmd} -- I have no idea what to do with that."
|
|
287
|
+
end
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
end
|
|
292
|
+
|
|
293
|
+
|
|
250
294
|
no_commands do
|
|
251
295
|
def valida_figura_rotulo (rotulo)
|
|
252
296
|
if (not rotulo =~ (/^[a-zA-Z][\w\-:]*$/)) then
|
data/lib/limarka/version.rb
CHANGED
data/limarka.gemspec
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: limarka
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Eduardo de Santana Medeiros Alexandre
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2016-12-
|
|
11
|
+
date: 2016-12-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -164,6 +164,20 @@ dependencies:
|
|
|
164
164
|
- - ">="
|
|
165
165
|
- !ruby/object:Gem::Version
|
|
166
166
|
version: '0'
|
|
167
|
+
- !ruby/object:Gem::Dependency
|
|
168
|
+
name: terminal-table
|
|
169
|
+
requirement: !ruby/object:Gem::Requirement
|
|
170
|
+
requirements:
|
|
171
|
+
- - ">="
|
|
172
|
+
- !ruby/object:Gem::Version
|
|
173
|
+
version: '0'
|
|
174
|
+
type: :runtime
|
|
175
|
+
prerelease: false
|
|
176
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
177
|
+
requirements:
|
|
178
|
+
- - ">="
|
|
179
|
+
- !ruby/object:Gem::Version
|
|
180
|
+
version: '0'
|
|
167
181
|
description: Com essa ferramenta você poderá escrever sua monografia, dissertação
|
|
168
182
|
ou tese utilizando Markdown (linguagem mais simples que Latex).
|
|
169
183
|
email:
|