Prep for release 0.0.1

Author: jmcnamara

README.md

@@ -1,15 +1,9 @@
-# xlsxwriter.lua
+# Xlsxwriter for Lua
 
 A Lua module for creating Excel XLSX files.
 
-## Work in progress
-
-The code is working and the documentation is almost complete. However, it is still a few days away from release so treat this as a beta.
-
-
 ## The xlsxwriter module
 
-
 Xlsxwriter is a Lua  module that can be used to write text, numbers and formulas
 to multiple worksheets in an Excel 2007+ XLSX file. It supports
 features such as:
@@ -18,15 +12,15 @@ features such as:
 * Full formatting.
 * Memory optimisation mode for writing large files.
 
-It supports Lua 5.1 and Lua 5.2.
+It works with Lua 5.1 and Lua 5.2.
 
 
 Here is an example:
 
 
 ```lua
 --
--- A simple example of some of the features of the xlsxwriter.lua module.
+-- A simple example of some of the features of the xlsxwriter module.
 --
 
 local Workbook = require "xlsxwriter.workbook"

dev/docs/source/author.rst

@@ -15,18 +15,17 @@ You can contact me at [email protected].
 Donations
 ---------
 
-If you would like to donate to the XlsxWriter project to keep it active you can
-do so via
+If you would like to donate to the xlsxwriter project to keep it active or to pay
+for the PDF copy of the documentation you can do so via
 `PayPal <https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RRZCPSL65X858>`_.
 
 .. raw:: html
 
    <center>
-   <form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
-   <input type="hidden" name="cmd" value="_s-xclick">
-   <input type="hidden" name="hosted_button_id" value="RRZCPSL65X858">
-   <input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
-   <img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
-   </form>
+    <form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
+    <input type="hidden" name="cmd" value="_s-xclick">
+    <input type="hidden" name="hosted_button_id" value="DL8AH2YG9XT42">
+    <input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
+    <img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
+    </form>
    </center>
-

dev/docs/source/bugs.rst

@@ -11,7 +11,7 @@ submit bug reports.
 Content is Unreadable. Open and Repair
 --------------------------------------
 
-Very, very occasionally you may see an Excel warning when opening an xlsxwriter.lua file like:
+Very, very occasionally you may see an Excel warning when opening an ``xlsxwriter`` file like:
 
    Excel could not open file.xlsx because some content is unreadable. Do you
    want to open and repair this workbook.
@@ -44,7 +44,7 @@ Formula results displaying as zero in non-Excel applications
 ------------------------------------------------------------
 
 Due to wide range of possible formulas and interdependencies between them,
-xlsxwriter.lua doesn't, and realistically cannot, calculate the result of a
+``xlsxwriter`` doesn't, and realistically cannot, calculate the result of a
 formula when it is written to an XLSX file. Instead, it stores the value 0 as
 the formula result. It then sets a global flag in the XLSX file to say that
 all formulas and functions should be recalculated when the file is opened.
@@ -63,7 +63,7 @@ formula using the optional ``value`` parameter in :func:`write_formula()`::
 Strings aren't displayed in Apple Numbers in 'constant_memory' mode
 -------------------------------------------------------------------
 
-In :func:`Workbook` ``'constant_memory'`` mode xlsxwriter.lua uses an optimisation where cell strings aren't stored in an Excel structure call "shared strings"
+In :func:`Workbook` ``'constant_memory'`` mode ``xlsxwriter`` uses an optimisation where cell strings aren't stored in an Excel structure call "shared strings"
 and instead are written "in-line".
 
 This is a documented Excel feature that is supported by most spreadsheet
@@ -78,21 +78,21 @@ Images inserted into worksheets via :func:`insert_image` may not display
 correctly in Excel 2011 for Mac and non-Excel applications such as OpenOffice
 and LibreOffice. Specifically the images may looked stretched or squashed.
 
-This is not specifically an xlsxwriter.lua issue. It also occurs with files created in Excel 2007 and Excel 2010.
+This is not specifically an ``xlsxwriter`` issue. It also occurs with files created in Excel 2007 and Excel 2010.
 
 
 
 Reporting Bugs
 ==============
 
-Here are some tips on reporting bugs in xlsxwriter.lua.
+Here are some tips on reporting bugs in ``xlsxwriter``.
 
 
 Upgrade to the latest version of the module
 -------------------------------------------
 
 The bug you are reporting may already be fixed in the latest version of the
-module. You can check which version of xlsxwriter.lua that you are using as
+module. You can check which version of ``xlsxwriter`` that you are using as
 follows::
 
     lua -e 'W = require "xlsxwriter.workbook"; print(W.version)'
@@ -103,7 +103,7 @@ Check the :ref:`changes` section to see what has changed in the latest versions.
 Read the documentation
 ----------------------
 
-Read or search the xlsxwriter.lua documentation to see if the issue you are
+Read or search the ``xlsxwriter`` documentation to see if the issue you are
 encountering is already explained.
 
 Look at the example programs
@@ -112,10 +112,10 @@ Look at the example programs
 There are many :ref:`example_programs` in the distribution. Try to identify an example
 program that corresponds to your query and adapt it to use as a bug report.
 
-Use the xlsxwriter.lua Issue tracker on GitHub
--------------------------------------------------------
+Use the xlsxwriter Issue tracker on GitHub
+------------------------------------------
 
-The `xlsxwriter.lua issue tracker <https://github.com/jmcnamara/xlsxwriter.lua/issues>`_ is on GitHub.
+The `xlsxwriter issue tracker <https://github.com/jmcnamara/xlsxwriter.lua/issues>`_ is on GitHub.
 
 
 Pointers for submitting a bug report
@@ -129,7 +129,7 @@ Pointers for submitting a bug report
 #. The sample program should be as small as possible to demonstrate the
    problem. Don't copy and paste large non-relevant sections of your program.
 
-A sample bug report is shown below. This format helps to analyse and respond to
+A sample bug report is shown below. This format helps analyse and respond to
 the bug report more quickly.
 
    **Issue with SOMETHING**

dev/docs/source/example_demo.rst

@@ -3,7 +3,7 @@
 Example: Simple Feature Demonstration
 =====================================
 
-This program is an example of writing some of the features of the xlsxwriter.lua
+This program is an example of writing some of the features of the ``xlsxwriter``
 module.
 
 .. image:: _images/demo.png

dev/docs/source/example_hello_world.rst

@@ -4,7 +4,7 @@ Example: Hello World
 ====================
 
 The simplest possible spreadsheet. This is a good place to start to see if
-the xlsxwriter.lua module is installed correctly.
+the ``xlsxwriter`` module is installed correctly.
 
 .. image:: _images/hello01.png
 

dev/docs/source/example_utf8.rst

@@ -5,7 +5,7 @@ Example: Write UTF-8 Strings
 
 An example of writing simple UTF-8 strings to a worksheet.
 
-Unicode strings in Excel must be UTF-8 encoded. With xlsxwriter.lua all that
+Unicode strings in Excel must be UTF-8 encoded. With ``xlsxwriter`` all that
 is required is that the source file is UTF-8 encoded and Lua will handle the
 UTF-8 strings like any other strings:
 

dev/docs/source/examples.rst

@@ -5,7 +5,7 @@ Examples
 
 The following are some of the examples included in the
 `examples <https://github.com/jmcnamara/xlsxwriter.lua/tree/master/examples>`_
-directory of the xlsxwriter.lua distribution.
+directory of the ``xlsxwriter`` distribution.
 
 .. toctree::
    :maxdepth: 1

dev/docs/source/faq.rst

@@ -14,15 +14,15 @@ Q. Can XlsxWriter use an existing Excel file as a template?
 
 No.
 
-Xlsxwriter.lua is designed only as a file *writer*. It cannot read or modify an
+Xlsxwriter is designed only as a file *writer*. It cannot read or modify an
 existing Excel file.
 
 
 Q. Why do my formulas show a zero result in some, non-Excel applications?
 -------------------------------------------------------------------------
 
 Due to wide range of possible formulas and interdependencies between them
-xlsxwriter.lua doesn't, and realistically cannot, calculate the result of a
+``xlsxwriter`` doesn't, and realistically cannot, calculate the result of a
 formula when it is written to an XLSX file. Instead, it stores the value 0 as
 the formula result. It then sets a global flag in the XLSX file to say that
 all formulas and functions should be recalculated when the file is opened.

dev/docs/source/format.rst

@@ -325,7 +325,7 @@ Excel's built-in formats are shown in the following table:
 
 .. note::
 
-   The dollar sign in the above format appears as the defined local currency
+   The dollar sign in the above formats appear as the defined local currency
    symbol.
 
 
@@ -532,7 +532,7 @@ an integer, is taken as the level of indentation::
     format1:set_indent(1)
     format2:set_indent(2)
 
-    worksheet:write("A1", "This text is indented 1 level", format1)
+    worksheet:write("A1", "This text is indented 1 level",  format1)
     worksheet:write("A2", "This text is indented 2 levels", format2)
 
 .. image:: _images/text_indent.png
@@ -562,7 +562,7 @@ format:set_text_justlast()
 
 .. function:: set_text_justlast()
 
-   Turn on the justify last text property.
+   Turn on the "justify last" text property.
 
 Only applies to Far Eastern versions of Excel.
 
@@ -646,7 +646,7 @@ A cell border is comprised of a border on the bottom, top, left and right.
 These can be set to the same value using ``set_border()`` or individually
 using the relevant method calls shown above.
 
-The following shows the border styles sorted by XlsxWriter index number:
+The following shows the border styles sorted by Excel index number:
 
 +-------+---------------+--------+-----------------+
 | Index | Name          | Weight | Style           |

dev/docs/source/getting_started.rst

@@ -1,59 +1,50 @@
 .. _getting_started:
 
-Getting Started with XlsxWriter
+Getting Started with xlsxwriter
 ===============================
 
 Here are some easy instructions to get you up and running with the xlsxwriter
 module.
 
 
-Installing Xlsxwriter.lua
--------------------------
+Installing xlsxwriter
+---------------------
 
-The first step is to install the xlsxwriter.lua module. There are several ways to do this.
+Xlsxwriter is a pure Lua module and doesn't need a native compiler to install. However, it has a dependency
+on the `ZipWriter <https://github.com/moteus/ZipWriter>`_ module which does have binary dependencies.
 
-.. Note::
+These dependencies are handled automatically if you use the ``luarocks`` or ``luadist`` methods shown below.
 
-   Xlsxwriter.lua has a dependency on the `ZipWriter <https://github.com/moteus/ZipWriter>`_ module.
 
 Using luarocks
 **************
 
-The easiest way to install xlsxwriter.lua is with the `luarocks <http://luarocks.org>`_ utility::
+The easiest way to install ``xlsxwriter`` is with the `luarocks <http://luarocks.org>`_ utility::
 
     $ sudo luarocks install xlsxwriter
 
 
+Using luadist
+*************
+
+Another easy "packaged" way of installing ``xlsxwriter`` is with the `luadist <http://luadist.org>`_ distribution::
+
+    $ sudo luadist install xlsxwriter
+
+
 Cloning from GitHub
 *******************
 
-The Xlsxwriter.lua source code and bug tracker is in the
+The ``xlsxwriter`` source code and bug tracker is in the
 `xlsxwriter.lua repository <http://github.com/jmcnamara/xlsxwriter.lua>`_ on GitHub.
 You can clone the repository and install from it as follows::
 
     $ git clone https://github.com/jmcnamara/xlsxwriter.lua.git
 
     $ cd xlsxwriter.lua
     $ sudo luarocks make
-
-
-Installing from a tarball
-*************************
-
-If you download a tarball of the latest version of xlsxwriter.lua you can install it as follows (change the version number to suit)::
-
-    $ tar -zxvf xlsxwriter-1.2.3.tar.gz
-
-    $ cd xlsxwriter-1.2.3
-    $ sudo luarocks make
-
-A tarball of the latest code can be downloaded from GitHub as follows::
-
-    $ curl -O -L http://github.com/jmcnamara/xlsxwriter.lua/archive/master.tar.gz
-
-    $ tar zxvf master.tar.gz
-    $ cd xlsxwriter.lua-master
-    $ sudo luarocks make
+    # or
+    $ sudo luadist make
 
 Running a sample program
 ------------------------
@@ -94,8 +85,8 @@ Documentation
 The latest version of this document is hosted on
 `Read The Docs <http://xlsxwriterlua.readthedocs.org>`_. It is also
 available as a
-`PDF <http://github.com/jmcnamara/xlsxwriter.lua/blob/master/docs/xlsxwriter_lua.pdf>`_.
+`PDF <http://github.com/jmcnamara/xlsxwriter.lua/blob/master/docs/xlsxwriter_lua.pdf?raw=true>`_.
 
 Once you are happy that the module is installed and operational you can have a
-look at the rest of the Xlsxwriter.lua documentation. :ref:`tutorial1` is a good
+look at the rest of the ``xlsxwriter`` documentation. :ref:`tutorial1` is a good
 place to start.

dev/docs/source/index.rst

@@ -1,7 +1,7 @@
 Creating Excel files with Lua and Xlsxwriter
 ============================================
 
-Xlsxwriter is a Lua module for creating Excel XLSX files.
+**Xlsxwriter** is a Lua module for creating Excel XLSX files.
 
 .. image:: _images/demo.png
 
@@ -11,15 +11,15 @@ Xlsxwriter is a Lua module for creating Excel XLSX files.
 
    **XlsxWriter**
 
-Xlsxwriter is a Lua  module that can be used to write text, numbers and formulas
+Xlsxwriter can be used to write text, numbers and formulas
 to multiple worksheets in an Excel 2007+ XLSX file. It supports
 features such as:
 
 * 100% compatible Excel XLSX files.
 * Full formatting.
 * Memory optimisation mode for writing large files.
 
-It supports Lua 5.1 and Lua 5.2.
+It works with Lua 5.1 and Lua 5.2.
 
 .. only:: html
 

dev/docs/source/introduction.rst

@@ -3,7 +3,7 @@
 Introduction
 ============
 
-**Xlsxwriter.lua** is a Lua module for writing files in the Excel 2007+ XLSX
+**Xlsxwriter** is a Lua module for writing files in the Excel 2007+ XLSX
 file format.
 
 It can be used to write text, numbers, and formulas to multiple worksheets and
@@ -23,6 +23,6 @@ However:
 
    * It can only create **new files**. It cannot read or modify existing files.
 
-XLsxwriter.lua is a port of the Perl `Excel::Writer::XLSX <http://search.cpan.org/~jmcnamara/Excel-Writer-XLSX/>`_ and the Python `XlsxWriter <http://xlsxwriter.readthedocs.org>`_ modules and is licensed under an MIT/X11 :ref:`License`.
+Xlsxwriter is a Lua port of the Perl `Excel::Writer::XLSX <http://search.cpan.org/~jmcnamara/Excel-Writer-XLSX/>`_ and the Python `XlsxWriter <http://xlsxwriter.readthedocs.org>`_ modules and is licensed under an MIT/X11 :ref:`License`.
 
 To try out the module see the next section on :ref:`getting_started`.

dev/docs/source/license.rst

@@ -3,7 +3,4 @@
 License
 =======
 
-XlsxWriter is released under a MIT license.
-
-
 .. include:: ../../../LICENSE.txt