Skip to content

Commit

Permalink
Minor doc changes and bug fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jsonkenl committed May 28, 2016
1 parent 088c3c4 commit c5089b5
Show file tree
Hide file tree
Showing 27 changed files with 172 additions and 149 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log

## 1.2.1

- Removed Ex-Doc and Earmark dependencies from Hex.
- Added Change Log link to Hex.
- Minor doc changes and bug fixes.

## 1.2.0

- Added `Xlsxir` access function `Xlsxir.get_mda/0` that accesses `:worksheet` ETS table and returns an indexed map which functions like a multi-dimensional array in other languages.
Expand Down
6 changes: 4 additions & 2 deletions OVERVIEW.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Xlsxir

Xlsxir is an Elixir library that parses `.xlsx` files using Simple API for XML (SAX) parsing via the [Erlsom](https://github.com/willemdj/erlsom) Erlang library, extracts the data to an Erlang Term Storage (ETS) process and provides various functions for accessing the data. Xlsxir supports ISO 8601 date formats and large files. Testing has been limited to various documents I have created or have access to and any issues submitted through GitHub, though I have succesfully parsed a worksheet containing 100 columns and 514K rows. Please submit any issues found and they will be addressed ASAP.
Xlsxir is an Elixir library that parses `.xlsx` files using Simple API for XML (SAX) parsing via the [Erlsom](https://github.com/willemdj/erlsom) Erlang library, extracts the data to an Erlang Term Storage (ETS) process and provides various functions for accessing the data. Xlsxir supports ISO 8601 date formats and large files.

Testing has been limited to various documents in Microsoft Excel and LibreOffice as well as any issues submitted through GitHub. Only English and Portuguese languages have been tested. A large worksheet containing 100 columns and 514K rows has successfully been parsed. Please submit any issues found and they will be addressed ASAP.

## Installation

You can add Xlsxir as a dependancy to your Elixir project via the Hex package manager by adding the following to your `mix.exs` file:

```elixir
def deps do
[ {:xlsxir, "~> 1.2"} ]
[ {:xlsxir, "~> 1.2.1"} ]
end
```

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,17 @@
[![Hex docs](http://img.shields.io/badge/hex.pm-docs-blue.svg?style=flat)](https://hexdocs.pm/xlsxir)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/kennellroxco/xlsxir/master/LICENSE)

Xlsxir is an Elixir library that parses `.xlsx` files using Simple API for XML (SAX) parsing via the [Erlsom](https://github.com/willemdj/erlsom) Erlang library, extracts the data to an Erlang Term Storage (ETS) process and provides various functions for accessing the data. Xlsxir supports ISO 8601 date formats and large files. Testing has been limited to various documents I have created or have access to and any issues submitted through GitHub, though I have succesfully parsed a worksheet containing 100 columns and 514K rows. Please submit any issues found and they will be addressed ASAP.
Xlsxir is an Elixir library that parses `.xlsx` files using Simple API for XML (SAX) parsing via the [Erlsom](https://github.com/willemdj/erlsom) Erlang library, extracts the data to an Erlang Term Storage (ETS) process and provides various functions for accessing the data. Xlsxir supports ISO 8601 date formats and large files.

Testing has been limited to various documents in Microsoft Excel and LibreOffice as well as any issues submitted through GitHub. Only English and Portuguese languages have been tested. A large worksheet containing 100 columns and 514K rows has successfully been parsed. Please submit any issues found and they will be addressed ASAP.

## Installation

You can add Xlsxir as a dependancy to your Elixir project via the Hex package manager by adding the following to your `mix.exs` file:

```elixir
def deps do
[ {:xlsxir, "~> 1.2"} ]
[ {:xlsxir, "~> 1.2.1"} ]
end
```

Expand Down
13 changes: 7 additions & 6 deletions doc/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>404 – Xlsxir v1.2.0</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<meta name="generator" content="ExDoc v0.11.5">
<title>404 – Xlsxir v1.2.1</title>
<link rel="stylesheet" href="dist/app-f9b4ee049e.css" />

<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="extras">
Expand All @@ -27,7 +28,7 @@ <h1 class="sidebar-projectName">
Xlsxir
</h1>
<h2 class="sidebar-projectVersion">
v1.2.0
v1.2.1
</h2>
</div>

Expand Down Expand Up @@ -69,7 +70,7 @@ <h2>Page not found</h2>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.5),
</span>
<span class="line">
designed by
Expand All @@ -81,7 +82,7 @@ <h2>Page not found</h2>
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
<script src="dist/app-918614602f.js"></script>
</body>
</html>

15 changes: 8 additions & 7 deletions doc/Xlsxir.ConvertDate.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>Xlsxir.ConvertDate – Xlsxir v1.2.0</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<meta name="generator" content="ExDoc v0.11.5">
<title>Xlsxir.ConvertDate – Xlsxir v1.2.1</title>
<link rel="stylesheet" href="dist/app-f9b4ee049e.css" />

<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
Expand All @@ -27,7 +28,7 @@ <h1 class="sidebar-projectName">
Xlsxir
</h1>
<h2 class="sidebar-projectVersion">
v1.2.0
v1.2.1
</h2>
</div>

Expand Down Expand Up @@ -59,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">Xlsxir v1.2.0</small>
<small class="visible-xs">Xlsxir v1.2.1</small>
Xlsxir.ConvertDate


Expand Down Expand Up @@ -188,7 +189,7 @@ <h2>Example</h2>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.5),
</span>
<span class="line">
designed by
Expand All @@ -200,7 +201,7 @@ <h2>Example</h2>
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
<script src="dist/app-918614602f.js"></script>
</body>
</html>

15 changes: 8 additions & 7 deletions doc/Xlsxir.Index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>Xlsxir.Index – Xlsxir v1.2.0</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<meta name="generator" content="ExDoc v0.11.5">
<title>Xlsxir.Index – Xlsxir v1.2.1</title>
<link rel="stylesheet" href="dist/app-f9b4ee049e.css" />

<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
Expand All @@ -27,7 +28,7 @@ <h1 class="sidebar-projectName">
Xlsxir
</h1>
<h2 class="sidebar-projectVersion">
v1.2.0
v1.2.1
</h2>
</div>

Expand Down Expand Up @@ -59,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">Xlsxir v1.2.0</small>
<small class="visible-xs">Xlsxir v1.2.1</small>
Xlsxir.Index


Expand Down Expand Up @@ -232,7 +233,7 @@ <h1 class="section-heading">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.5),
</span>
<span class="line">
designed by
Expand All @@ -244,7 +245,7 @@ <h1 class="section-heading">
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
<script src="dist/app-918614602f.js"></script>
</body>
</html>

15 changes: 8 additions & 7 deletions doc/Xlsxir.ParseString.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>Xlsxir.ParseString – Xlsxir v1.2.0</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<meta name="generator" content="ExDoc v0.11.5">
<title>Xlsxir.ParseString – Xlsxir v1.2.1</title>
<link rel="stylesheet" href="dist/app-f9b4ee049e.css" />

<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
Expand All @@ -27,7 +28,7 @@ <h1 class="sidebar-projectName">
Xlsxir
</h1>
<h2 class="sidebar-projectVersion">
v1.2.0
v1.2.1
</h2>
</div>

Expand Down Expand Up @@ -59,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">Xlsxir v1.2.0</small>
<small class="visible-xs">Xlsxir v1.2.1</small>
Xlsxir.ParseString


Expand Down Expand Up @@ -164,7 +165,7 @@ <h2>Example</h2>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.5),
</span>
<span class="line">
designed by
Expand All @@ -176,7 +177,7 @@ <h2>Example</h2>
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
<script src="dist/app-918614602f.js"></script>
</body>
</html>

15 changes: 8 additions & 7 deletions doc/Xlsxir.ParseStyle.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>Xlsxir.ParseStyle – Xlsxir v1.2.0</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<meta name="generator" content="ExDoc v0.11.5">
<title>Xlsxir.ParseStyle – Xlsxir v1.2.1</title>
<link rel="stylesheet" href="dist/app-f9b4ee049e.css" />

<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
Expand All @@ -27,7 +28,7 @@ <h1 class="sidebar-projectName">
Xlsxir
</h1>
<h2 class="sidebar-projectVersion">
v1.2.0
v1.2.1
</h2>
</div>

Expand Down Expand Up @@ -59,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">Xlsxir v1.2.0</small>
<small class="visible-xs">Xlsxir v1.2.1</small>
Xlsxir.ParseStyle


Expand Down Expand Up @@ -164,7 +165,7 @@ <h2>Example</h2>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.5),
</span>
<span class="line">
designed by
Expand All @@ -176,7 +177,7 @@ <h2>Example</h2>
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
<script src="dist/app-918614602f.js"></script>
</body>
</html>

15 changes: 8 additions & 7 deletions doc/Xlsxir.ParseWorksheet.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>Xlsxir.ParseWorksheet – Xlsxir v1.2.0</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<meta name="generator" content="ExDoc v0.11.5">
<title>Xlsxir.ParseWorksheet – Xlsxir v1.2.1</title>
<link rel="stylesheet" href="dist/app-f9b4ee049e.css" />

<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
Expand All @@ -27,7 +28,7 @@ <h1 class="sidebar-projectName">
Xlsxir
</h1>
<h2 class="sidebar-projectVersion">
v1.2.0
v1.2.1
</h2>
</div>

Expand Down Expand Up @@ -59,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">Xlsxir v1.2.0</small>
<small class="visible-xs">Xlsxir v1.2.1</small>
Xlsxir.ParseWorksheet


Expand Down Expand Up @@ -163,7 +164,7 @@ <h2>Example</h2>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.5),
</span>
<span class="line">
designed by
Expand All @@ -175,7 +176,7 @@ <h2>Example</h2>
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
<script src="dist/app-918614602f.js"></script>
</body>
</html>

15 changes: 8 additions & 7 deletions doc/Xlsxir.SaxParser.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>Xlsxir.SaxParser – Xlsxir v1.2.0</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<meta name="generator" content="ExDoc v0.11.5">
<title>Xlsxir.SaxParser – Xlsxir v1.2.1</title>
<link rel="stylesheet" href="dist/app-f9b4ee049e.css" />

<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
Expand All @@ -27,7 +28,7 @@ <h1 class="sidebar-projectName">
Xlsxir
</h1>
<h2 class="sidebar-projectVersion">
v1.2.0
v1.2.1
</h2>
</div>

Expand Down Expand Up @@ -59,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">Xlsxir v1.2.0</small>
<small class="visible-xs">Xlsxir v1.2.1</small>
Xlsxir.SaxParser


Expand Down Expand Up @@ -192,7 +193,7 @@ <h2>Example</h2>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.5),
</span>
<span class="line">
designed by
Expand All @@ -204,7 +205,7 @@ <h2>Example</h2>
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
<script src="dist/app-918614602f.js"></script>
</body>
</html>

Loading

0 comments on commit c5089b5

Please sign in to comment.