- Updates documentation and translate it to English.

- General refactoring.
- Includes configurations to deploy the project to Maven Central.
- Adds maven-license-plugin to include copyright notice at top of java files.
- Adds new badges to README.md

Author: manoelcampos

.gitignore

@@ -1,6 +1,11 @@
+*.iml
+*.ipr
+*.iws
 *.jar
 *.class
 .classpath
 .settings/
 /bin/
-/target/
+/target/
+lua-sample-app/highlights.lua
+lua-sample-app/products.lua

COPYRIGHT

@@ -0,0 +1,17 @@
+Xml2Lua: Converts XML files to Lua format.
+    Copyright (C) 2011-2016  Manoel Campos da Silva Filho (http://manoelcampos.com)
+
+    This file is part of Xml2Lua.
+
+    Xml2Lua is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Xml2Lua is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Xml2Lua. If not, see <http://www.gnu.org/licenses/>.

LICENSE

@@ -1,5 +1,5 @@
-Introducão [![Build Status](https://travis-ci.org/manoelcampos/Xml2Lua.png?branch=master)](https://travis-ci.org/manoelcampos/Xml2Lua)
-----------
+# Introducão [![Build Status](https://travis-ci.org/manoelcampos/JavaXml2Lua.png?branch=master)](https://travis-ci.org/manoelcampos/JavaXml2Lua) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.manoelcampos/xml2lua/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.manoelcampos/xml2lua) [![Javadocs](https://www.javadoc.io/badge/com.manoelcampos/xml2lua.svg)](https://www.javadoc.io/doc/com.manoelcampos/xml2lua) [![GPL licensed](https://img.shields.io/badge/license-GPL-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
+
 
 XML é um padrão internacional da W3C para intercâmbio de dados, amplamente utilizado e conhecido. Tal formato permite a troca de dados entre sistemas heterogêneos, garantindo a interoperabilidade entre os mesmos. No entanto, em aplicações interativas para o Sistema Brasileiro de TV Digital, desenvolvidas em NCL e Lua, tem-se uma alternativa bem mais simples que o uso de arquivos XML para a representação, armazenamento e troca de dados: os arquivos de dados em formato Lua, como já mostrei [neste post](http://manoelcampos.com/2010/06/08/aplicacao-de-tv-digital-usando-arquivos-de-dados-em-lua/).
 
@@ -8,8 +8,7 @@ O uso de tais arquivos traz vários benefícios como: tamanho menor (menos bytes
 Por demandar uma capacidade mínima de processamento, o uso de arquivos de dados em formato Lua é ideal para ambientes de recursos de hardware restritos como os equipamentos de recepção de TV Digital, além de simplificar o código da aplicação para a manipulação de tais dados.
 
 
-O problema
-----------
+# O problema
 
 O uso de arquivos XML em aplicações NCL/Lua para a TVD (enviadas via broadcast) é perfeitamente possível desde que tenha-se um parser escrito inteiramente em Lua, como o [LuaXML](https://github.com/manoelcampos/LuaXML) (veja o [Leitor de RSS em NCLua](https://github.com/manoelcampos/NCLuaRSS-Reader)). Tal parser converte um arquivo XML para uma tabela Lua, armazenando a mesma em RAM. Desta forma, a manipulação dos dados fica mais fácil. No link anterior existe uma versão do parser, adaptada por mim, que funciona com Lua 5 (a versão utilizada no subsistema Ginga-NCL do middleware Ginga).
 
@@ -20,23 +19,19 @@ Apesar de ser possível a atualização do middleware, sabemos que nem todos os
 Desta forma, usar arquivos XML localmente não garante que a aplicação executará em qualquer implementação de Ginga.
 
 
-A solução: Xml2Lua
-------------------
-
+# A solução: Xml2Lua
 
 Para resolver tal problema, estou disponibilizando uma aplicação console em Java para converter um arquivo XML para o formato Lua. A aplicação utiliza o parser DOM (que se não estou errado é padrão no JDK e JRE) para percorrer os elementos do arquivo XML e assim poder gerar um arquivo Lua com os dados contidos no primeiro.
 
 Para tal conversão, poderia ser utilizada qualquer linguagem de programação, até mesmo Lua, com uso do [LuaXML](https://github.com/manoelcampos/LuaXML) (para fazer o parse do XML) e o [table.save](http://lua-users.org/wiki/SaveTableToFile) (para salvar a tabela Lua, gerada a partir do XML, em disco). No entanto, o arquivo lua gerado com o table.save não ficou muito organizado e incluiu muito lixo, dificultando a manipulação dos dados. Por este motivo, resolvi implementar a ferramenta em Java.
 
 A implementação realizada está disponível no final do artigo, juntamente com toda a documentação e código fonte.  Ela possui uma ferramenta de linha de comando (para ser usada antes de enviar a aplicação NCL/Lua via broadcast) para fazer a conversão do XML para Lua. Além disto, existe também uma classe Java que pode ser usada em qualquer outra aplicação (Desktop ou Web), permitindo a integração de tal implementação em sistemas já existentes, para, por exemplo, automatizar a conversão dos arquivos XML para Lua, para assim poderem ser enviados pelo carrossel para transmissão em broadcast.
 
-Documentação
-------------
+# Documentação
 
 A documentação da API está [disponível online aqui](http://manoelcampos.github.io/Xml2Lua/apidocs).
 
-Usando a ferramenta
--------------------
+# Usando a ferramenta
 
 Para usar a ferramenta de linha de comando, basta executar em um terminal:
 
@@ -46,12 +41,11 @@ java -jar xml2lua.jar NomeArquivoXML
 
 Note que deve-se informar o nome de um arquivo XML. A aplicação gerará um arquivo Lua de mesmo nome, dentro do diretório atual.
 
-Estudo de caso
---------------
+# Estudo de caso
 
 Para exemplificar o uso da ferramenta, vamos imaginar que temos uma aplicação NCL/Lua de uma loja virtual, que precisa exibir uma lista de produtos na tela. As informações de tais produtos estão em um arquivo XML que será convertido para um arquivo Lua.
 
-Para isto, usaremos um arquivo de nome produtos.xml, com o conteúdo a seguir. Todos os arquivos XML e o código do exemplo apresentado aqui está disponível na pasta [exemplo](exemplo).
+Para isto, usaremos um arquivo de nome produtos.xml, com o conteúdo a seguir. Todos os arquivos XML e o código do exemplo apresentado aqui está disponível na pasta [lua-sample-app](lua-sample-app).
 
 ```xml
 <produtos>
@@ -153,7 +147,6 @@ A partir de um for em tal tabela, pegando-se o valor do campo id, pode-se acessa
 
 ## Código da aplicação Lua
 
-
 Após terem sido convertidos os arquivos produtos.xml e destaques.xml para Lua, podemos ter uma aplicação Lua  para carregar tais arquivos Lua e exibir os dados, como pode ser visto no trecho de código a seguir. A aplicação não possui interface gráfica pois isto está fora do escopo do artigo. Ela apenas exibe os dados no terminal. Tal código está disponível no arquivo app.lua, no pacote para download.
 
 ```lua
@@ -176,8 +169,7 @@ lua app.lua
 ```
 
 
-Conclusão
----------
+# Conclusão
 
 Como as aplicações de TVD (por exemplo, as de comércio eletrônico) podem ser apenas uma nova interface gráfica para sistemas já existentes que usam XML, WebServices e outras tecnologias como a base da arquitetura destes, implementar a geração de arquivos de dados Lua em tais arquiteturas pode ser algo trabalhoso.
 

README.md

@@ -0,0 +1,10 @@
+# Sample Lua Application
+
+This directory contains a sample lua application which prints the data inside the Lua files generated from the XML files,
+using the Java Xml2Lua tool.
+
+The following files are available:
+
+- converter.sh: a script which converts the XML files into the current directory to Lua files, so that they can be used by the app.lua application.
+- products.xml and highlights.xml: sample XML files to be converted to Lua files.
+- app.lua: Lua application which prints the data inside the Lua files generated from the XML files.

exemplo/app.lua

@@ -0,0 +1,13 @@
+#!/usr/bin/env lua
+
+---Application which loads some lua files converted from XML files using the Java Xml2Lua tool.
+--@author Manoel Campos da Silva Filho - http://manoelcampos.com
+print "\nNOTE: Run the converter.sh script to generate the products.lua and highlights.lua from the respective XML files.\n"
+local products = dofile("products.lua")
+local highlights = dofile("highlights.lua")
+
+local prod = {}
+for i, highlight in pairs(highlights) do
+    prod = products[highlight.id]
+    print("Id: ", dest.id, "Brand:", prod.branc, "Price:", prod.price, "Description:", prod.description)
+end