limarka 0.4.4 → 0.4.5
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/.github_changelog_generator +0 -4
- data/CHANGELOG.md +24 -44
- data/README.md +15 -19
- data/Rakefile +6 -2
- data/lib/limarka/cli.rb +0 -1
- data/lib/limarka/ref.rb +20 -20
- data/lib/limarka/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 21da50b020bf07d44668b264dd2a014a3dfee9bd
|
|
4
|
+
data.tar.gz: 5d7afab61696403096825635c919c8adf468c102
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d3e4767268647880bf0c67d34bb185c5df79ddb2663654cfed1d889110616cf5b308815e2af86b29a8fc655a9f780eeb0179eded79073bfe965a5171ff24543b
|
|
7
|
+
data.tar.gz: 33376976a00659fd17d3fe000cfd7baca821555b8548bcc3fb8996b2f7554bb2f0de90bf48a8d86f15310b6be1e86434cb9aec66a455331f2312c4bd9e8a58b0
|
data/.github_changelog_generator
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,20 +1,36 @@
|
|
|
1
1
|
# Change Log
|
|
2
2
|
|
|
3
|
+
## [v0.4.5](https://github.com/abntex/limarka/tree/v0.4.5) (2016-11-20)
|
|
4
|
+
[Full Changelog](https://github.com/abntex/limarka/compare/v0.4.4...v0.4.5)
|
|
5
|
+
|
|
6
|
+
**Melhorias implementadas:**
|
|
7
|
+
|
|
8
|
+
- Geração do CHANGELOG com termos em português [\#77](https://github.com/abntex/limarka/issues/77)
|
|
9
|
+
|
|
10
|
+
**Bugs corrigidos:**
|
|
11
|
+
|
|
12
|
+
- Inconsistência ao adicionar referencia do clipboard [\#76](https://github.com/abntex/limarka/issues/76)
|
|
13
|
+
- Comando fig não apresenta a legenda apropriada no modo interativo [\#74](https://github.com/abntex/limarka/issues/74)
|
|
14
|
+
|
|
15
|
+
**Issues fechados:**
|
|
16
|
+
|
|
17
|
+
- Apresentação de funcionalidades no README [\#75](https://github.com/abntex/limarka/issues/75)
|
|
18
|
+
|
|
3
19
|
## [v0.4.4](https://github.com/abntex/limarka/tree/v0.4.4) (2016-11-18)
|
|
4
20
|
[Full Changelog](https://github.com/abntex/limarka/compare/v0.4.3...v0.4.4)
|
|
5
21
|
|
|
6
|
-
**
|
|
22
|
+
**Bugs corrigidos:**
|
|
7
23
|
|
|
8
24
|
- Correção no comentário de inserir figura [\#73](https://github.com/abntex/limarka/issues/73)
|
|
9
25
|
|
|
10
26
|
## [v0.4.3](https://github.com/abntex/limarka/tree/v0.4.3) (2016-11-18)
|
|
11
27
|
[Full Changelog](https://github.com/abntex/limarka/compare/v0.4.2...v0.4.3)
|
|
12
28
|
|
|
13
|
-
**
|
|
29
|
+
**Melhorias implementadas:**
|
|
14
30
|
|
|
15
31
|
- Sugere número de página para citações diretas [\#72](https://github.com/abntex/limarka/issues/72)
|
|
16
32
|
|
|
17
|
-
**
|
|
33
|
+
**Issues fechados:**
|
|
18
34
|
|
|
19
35
|
- Atualizando documentação no Wiki [\#65](https://github.com/abntex/limarka/issues/65)
|
|
20
36
|
- Implementar mecanismo de ajuda [\#25](https://github.com/abntex/limarka/issues/25)
|
|
@@ -23,21 +39,21 @@
|
|
|
23
39
|
## [v0.4.2](https://github.com/abntex/limarka/tree/v0.4.2) (2016-11-18)
|
|
24
40
|
[Full Changelog](https://github.com/abntex/limarka/compare/v0.4.1...v0.4.2)
|
|
25
41
|
|
|
26
|
-
**
|
|
42
|
+
**Issues fechados:**
|
|
27
43
|
|
|
28
44
|
- Opção de criar tabelas [\#37](https://github.com/abntex/limarka/issues/37)
|
|
29
45
|
|
|
30
46
|
## [v0.4.1](https://github.com/abntex/limarka/tree/v0.4.1) (2016-11-17)
|
|
31
47
|
[Full Changelog](https://github.com/abntex/limarka/compare/v0.4.0...v0.4.1)
|
|
32
48
|
|
|
33
|
-
**
|
|
49
|
+
**Issues fechados:**
|
|
34
50
|
|
|
35
51
|
- Possibilitar incluir referência bibtex da área de transferência [\#69](https://github.com/abntex/limarka/issues/69)
|
|
36
52
|
|
|
37
53
|
## [v0.4.0](https://github.com/abntex/limarka/tree/v0.4.0) (2016-11-16)
|
|
38
54
|
[Full Changelog](https://github.com/abntex/limarka/compare/v0.3.0...v0.4.0)
|
|
39
55
|
|
|
40
|
-
**
|
|
56
|
+
**Melhorias implementadas:**
|
|
41
57
|
|
|
42
58
|
- Indicar a versão de utilização do limarka [\#64](https://github.com/abntex/limarka/issues/64)
|
|
43
59
|
- Aumentar o provisionamento de inclusão de Figura [\#39](https://github.com/abntex/limarka/issues/39)
|
|
@@ -45,11 +61,11 @@
|
|
|
45
61
|
## [v0.3.0](https://github.com/abntex/limarka/tree/v0.3.0) (2016-11-02)
|
|
46
62
|
[Full Changelog](https://github.com/abntex/limarka/compare/0.2.0...v0.3.0)
|
|
47
63
|
|
|
48
|
-
**
|
|
64
|
+
**Bugs corrigidos:**
|
|
49
65
|
|
|
50
66
|
- Correção do Sumário quando a lista de siglas está vazia [\#20](https://github.com/abntex/limarka/issues/20)
|
|
51
67
|
|
|
52
|
-
**
|
|
68
|
+
**Issues fechados:**
|
|
53
69
|
|
|
54
70
|
- Inclusão de simbolos [\#62](https://github.com/abntex/limarka/issues/62)
|
|
55
71
|
- Emite mensagem de erro se não encontrar arquivo configuracao.yaml [\#61](https://github.com/abntex/limarka/issues/61)
|
|
@@ -78,42 +94,6 @@
|
|
|
78
94
|
- Tornar o projeto atrativo a desenvolvedores [\#31](https://github.com/abntex/limarka/issues/31)
|
|
79
95
|
- Organizar documentação do projeto [\#21](https://github.com/abntex/limarka/issues/21)
|
|
80
96
|
|
|
81
|
-
## [0.2.0](https://github.com/abntex/limarka/tree/0.2.0) (2016-08-17)
|
|
82
|
-
[Full Changelog](https://github.com/abntex/limarka/compare/0.1.0...0.2.0)
|
|
83
|
-
|
|
84
|
-
**Closed issues:**
|
|
85
|
-
|
|
86
|
-
- TDD: tornar o projeto testável [\#30](https://github.com/abntex/limarka/issues/30)
|
|
87
|
-
- Criar executável do sistema [\#29](https://github.com/abntex/limarka/issues/29)
|
|
88
|
-
- Configuração e geração da Errata [\#32](https://github.com/abntex/limarka/issues/32)
|
|
89
|
-
- Apêndices [\#28](https://github.com/abntex/limarka/issues/28)
|
|
90
|
-
- Anexos [\#27](https://github.com/abntex/limarka/issues/27)
|
|
91
|
-
- Referências [\#26](https://github.com/abntex/limarka/issues/26)
|
|
92
|
-
- Tornar o projeto administrável com o bundle [\#24](https://github.com/abntex/limarka/issues/24)
|
|
93
|
-
- Renomear o repositório para limarka [\#23](https://github.com/abntex/limarka/issues/23)
|
|
94
|
-
- Sumário [\#19](https://github.com/abntex/limarka/issues/19)
|
|
95
|
-
- Lista de símbolos [\#18](https://github.com/abntex/limarka/issues/18)
|
|
96
|
-
- Lista de abreviaturas e siglas [\#17](https://github.com/abntex/limarka/issues/17)
|
|
97
|
-
- Lista de tabelas [\#16](https://github.com/abntex/limarka/issues/16)
|
|
98
|
-
- Lista de ilustrações [\#15](https://github.com/abntex/limarka/issues/15)
|
|
99
|
-
- Resumos \(obrigatório\) [\#14](https://github.com/abntex/limarka/issues/14)
|
|
100
|
-
- Epígrafe \(opcional\) [\#13](https://github.com/abntex/limarka/issues/13)
|
|
101
|
-
- Agradecimentos \(opcional\) [\#12](https://github.com/abntex/limarka/issues/12)
|
|
102
|
-
- Dedicatória [\#11](https://github.com/abntex/limarka/issues/11)
|
|
103
|
-
- Manter configuração na master [\#10](https://github.com/abntex/limarka/issues/10)
|
|
104
|
-
- Configuração e geração do pre-textual [\#7](https://github.com/abntex/limarka/issues/7)
|
|
105
|
-
|
|
106
|
-
## [0.1.0](https://github.com/abntex/limarka/tree/0.1.0) (2016-07-15)
|
|
107
|
-
**Closed issues:**
|
|
108
|
-
|
|
109
|
-
- Gerenciar changelog com github\_changelog\_generator [\#9](https://github.com/abntex/limarka/issues/9)
|
|
110
|
-
- Esconder arquivos que usuário não utiliza [\#8](https://github.com/abntex/limarka/issues/8)
|
|
111
|
-
- Corrigir dependência do pdf-forms [\#6](https://github.com/abntex/limarka/issues/6)
|
|
112
|
-
- Elaboração do formulário PDF em branch separada [\#5](https://github.com/abntex/limarka/issues/5)
|
|
113
|
-
- Implementação da ficha catalográfica e folha de aprovação [\#3](https://github.com/abntex/limarka/issues/3)
|
|
114
|
-
- Configurações serão realizadas em arquivo PDF [\#2](https://github.com/abntex/limarka/issues/2)
|
|
115
|
-
- Fornecer informações básicas sobre o projeto [\#1](https://github.com/abntex/limarka/issues/1)
|
|
116
|
-
|
|
117
97
|
|
|
118
98
|
|
|
119
99
|
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
data/README.md
CHANGED
|
@@ -6,14 +6,11 @@ O limarka é uma ferramenta que possibilita o usuário escrever o seu trabalho d
|
|
|
6
6
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
|
-
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?
|
|
10
|
-
|
|
11
|
-
> Uma reposta seria: *Com o Latex e abnTeX eu serei capaz de produzir um trabalho em conformidade com as normas da ABNT, isso por si só já compensaria o investimento*.
|
|
12
|
-
|
|
9
|
+
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?
|
|
13
10
|
|
|
14
11
|
## Markdown como alternativa de aprendizado
|
|
15
12
|
|
|
16
|
-
Com o limarka você agora possui outra
|
|
13
|
+
Com o limarka você agora possui outra alternativa de investimento: *aprender Markdown* (que é bastante simples).
|
|
17
14
|
|
|
18
15
|
O [Markdown](https://pt.wikipedia.org/wiki/Markdown) é uma [linguagem simples de marcação](https://en.wikipedia.org/wiki/Lightweight_markup_language). Os princípios das linguagem simples de marcação estão sendo popularizados em diversas ferramentas de interação social, veja alguns exemplos: [Github](https://help.github.com/articles/basic-writing-and-formatting-syntax/), [Moodle](https://docs.moodle.org/23/en/Markdown), [WhatsApp](https://www.whatsapp.com/faq/en/general/26000002), [Facebook](http://wersm.com/facebook-is-testing-rich-text-formatting-with-markdown/) [Google Plus](https://plus.google.com/+SarahHill/posts/TWYwPctEpJp), [Jekyll](http://jekyllrb.com), etc.
|
|
19
16
|
|
|
@@ -26,38 +23,37 @@ Após ou durante conclusão do seu curso, você pretende:
|
|
|
26
23
|
- Gerar código HTML a partir de texto?
|
|
27
24
|
- Elaborar *ebooks*?
|
|
28
25
|
|
|
29
|
-
Se você respondeu afirmativamente a algumas dessas perguntas, aprender uma linguagem simples de marcação (como o Markdown) é um investimento
|
|
26
|
+
Se você respondeu afirmativamente a algumas dessas perguntas, aprender uma linguagem simples de marcação (como o Markdown) é um investimento rentável.
|
|
30
27
|
|
|
31
28
|
**OBS:** A implementação atual do limarka ainda exige conhecimentos mínimos do Latex.
|
|
32
29
|
|
|
33
|
-
|
|
34
30
|
# Qual a relação do limarka com o abnTeX?
|
|
35
31
|
|
|
36
32
|
O [abnTeX](https://github.com/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.
|
|
37
33
|
|
|
38
|
-
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. O limarka é um projeto pertencente ao grupo do [abnTeX](https://github.com/abntex).
|
|
39
|
-
|
|
34
|
+
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](https://github.com/abntex).
|
|
40
35
|
|
|
41
|
-
#
|
|
36
|
+
# Funcionalidades
|
|
42
37
|
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
-
|
|
38
|
+
- Utilização da linguagem Markdown para escrita do texto;
|
|
39
|
+
- Configurações através de formulário PDF ou arquivo YAML;
|
|
40
|
+
- Possibilidade de inclusão de códigos Latex;
|
|
41
|
+
- Facilidade para geração de códigos para inclusão de Figuras, Tabelas, Referências e Citações;
|
|
42
|
+
- Facilidade em edição ou personalização de templates;
|
|
43
|
+
- Facilidade de obter suporte ao código Latex gerado (compatível com o estilo do abnTeX2);
|
|
47
44
|
|
|
48
45
|
# Documentação
|
|
49
46
|
|
|
50
47
|
A documentação do limarka será mantida no [wiki do projeto](https://github.com/abntex/limarka/wiki).
|
|
51
48
|
|
|
49
|
+
- [Vídeos](https://www.youtube.com/playlist?list=PLTnAY6TvPRKK6OgGYy3UA0oFdfCfRZesY)
|
|
50
|
+
|
|
52
51
|
# Origem do projeto
|
|
53
52
|
|
|
54
53
|
O projeto tem como origem uma pesquisa científica sobre utilização de linguagem de marcação de texto para elaboração de monografias (em andamento).
|
|
55
54
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
59
|
-
|
|
60
|
-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
55
|
+
- Deseja participar da pesquisa científica do projeto?
|
|
56
|
+
- [Deseja contribuir com o desenvolvimento?](https://github.com/abntex/limarka/wiki/Desenvolvimento)
|
|
61
57
|
|
|
62
58
|
# Contributing
|
|
63
59
|
|
data/Rakefile
CHANGED
|
@@ -19,8 +19,12 @@ RSpec::Core::RakeTask.new(:spec)
|
|
|
19
19
|
|
|
20
20
|
task :default => [:configuracao_padrao, 'spec:fast']
|
|
21
21
|
|
|
22
|
-
GitHubChangelogGenerator::RakeTask.new :changelog do |
|
|
23
|
-
|
|
22
|
+
GitHubChangelogGenerator::RakeTask.new :changelog do |c|
|
|
23
|
+
c.future_release = "v"+Limarka::VERSION
|
|
24
|
+
c.bug_prefix="**Bugs corrigidos:**"
|
|
25
|
+
c.issue_prefix = "**Issues fechados:**"
|
|
26
|
+
c.enhancement_prefix="**Melhorias implementadas:**"
|
|
27
|
+
c.since_tag="0.2.0"
|
|
24
28
|
end
|
|
25
29
|
|
|
26
30
|
|
data/lib/limarka/cli.rb
CHANGED
data/lib/limarka/ref.rb
CHANGED
|
@@ -7,7 +7,8 @@ require 'clipboard'
|
|
|
7
7
|
module Limarka
|
|
8
8
|
|
|
9
9
|
class Ref < Thor
|
|
10
|
-
|
|
10
|
+
include Thor::Actions
|
|
11
|
+
|
|
11
12
|
method_option :clipboard, :aliases => '-c', :desc => 'Incluir referência bibtex do clipboard (área de transferência)', :default => false, :type => :boolean
|
|
12
13
|
method_option :bibfile, :aliases => '-f', :desc => 'Arquivo de referências bibtex onde será incluído a referência', :default => "referencias.bib", :type => :string
|
|
13
14
|
desc "add", "Adiciona referência ao arquivo de bibliografia."
|
|
@@ -20,26 +21,25 @@ DESC
|
|
|
20
21
|
else
|
|
21
22
|
referencia = $stdin.read
|
|
22
23
|
end
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
end
|
|
35
|
-
puts <<MSG
|
|
36
|
-
|
|
37
|
-
#{entry[0]}
|
|
38
|
-
|
|
39
|
-
Para citar utilize: \\cite{#{entry[0].key}} ou \\citeonline{#{entry[0].key}}
|
|
40
|
-
As citações diretas devem indicar a página (NBR 10520:2002, item 5.1): \\cite[p. XXX]{#{entry[0].key}}
|
|
41
|
-
|
|
24
|
+
begin
|
|
25
|
+
entry = BibTeX.parse(referencia)
|
|
26
|
+
error = entry.length.zero?
|
|
27
|
+
if not error then
|
|
28
|
+
append_to_file options[:bibfile], referencia
|
|
29
|
+
|
|
30
|
+
puts <<MSG
|
|
31
|
+
A seguinte referência foi adicionado ao arquivo '#{options[:bibfile]}':
|
|
32
|
+
#{referencia}
|
|
33
|
+
ABNT NBR 10520:2002(5.1): As citações diretas devem indicar a página.
|
|
34
|
+
Como citar no texto: \\cite{#{entry[0].key}} \\cite[p. XXX]{#{entry[0].key}} \\citeonline{#{entry[0].key}}
|
|
42
35
|
MSG
|
|
36
|
+
end
|
|
37
|
+
rescue BibTeX::ParseError
|
|
38
|
+
error = true
|
|
39
|
+
end
|
|
40
|
+
if (error) then
|
|
41
|
+
puts "Entrada não apresenta uma referência válida:\n#{referencia}"
|
|
42
|
+
return 1
|
|
43
43
|
end
|
|
44
44
|
end
|
|
45
45
|
end
|
data/lib/limarka/version.rb
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.
|
|
4
|
+
version: 0.4.5
|
|
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-11-
|
|
11
|
+
date: 2016-11-20 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|