mirror of
https://github.com/jmcnamara/libxlsxwriter
synced 2025-03-28 21:13:14 +00:00
Spelling fixes.
This commit is contained in:
parent
92b67d84ce
commit
29b3a0de0b
25
Readme.md
25
Readme.md
@ -13,19 +13,18 @@ Libxlsxwriter is a C library that can be used to write text, numbers, formulas a
|
||||
|
||||
It supports features such as:
|
||||
|
||||
- 100% compatible Excel XLSX files
|
||||
- Full Excel formatting
|
||||
- Merged cells
|
||||
- Autofilters
|
||||
- Defined names
|
||||
- Memory optimisation mode for writing large files
|
||||
- Source code available on [GitHub](https://github.com/jmcnamara/libxlsxwriter)
|
||||
- FreeBSD license
|
||||
- ANSI C
|
||||
- Works with GCC 4.4, 4.6, 4.7, 4.8, 4.9, Clang, ICC and TCC.
|
||||
- Works on Linux, FreeBSD, OS X and iOS.
|
||||
- The only dependency is on `zlib`
|
||||
|
||||
- 100% compatible Excel XLSX files.
|
||||
- Full Excel formatting.
|
||||
- Merged cells.
|
||||
- Defined names.
|
||||
- Autofilters.
|
||||
- Memory optimisation mode for writing large files.
|
||||
- Source code available on [GitHub](https://github.com/jmcnamara/libxlsxwriter).
|
||||
- FreeBSD @ref license.
|
||||
- ANSI C.
|
||||
- Works with GCC 4.x, GCC 5.x, Clang, Xcode, MSVC 2015, ICC and TCC.
|
||||
- Works on Linux, FreeBSD, OS X, iOS and Windows.
|
||||
- The only dependency is on `zlib`.
|
||||
|
||||
Here is an example that was used to create the spreadsheet shown above:
|
||||
|
||||
|
@ -121,7 +121,7 @@ tracker](https://github.com/jmcnamara/libxlsxwriter/issues) is on GitHub.
|
||||
problem. Don't copy and paste large non-relevant sections of your
|
||||
program.
|
||||
|
||||
A sample bug report is shown below. This format helps analyse and respond to
|
||||
A sample bug report is shown below. This format helps analyze and respond to
|
||||
the bug report more quickly.
|
||||
|
||||
Issue with SOMETHING
|
||||
|
@ -22,7 +22,7 @@ features such as:
|
||||
- Source code available on [GitHub](https://github.com/jmcnamara/libxlsxwriter).
|
||||
- FreeBSD @ref license.
|
||||
- ANSI C.
|
||||
- Works with GCC 4.x, GCC 5.x, Clang, Xcode, MSVS 2015, ICC and TCC.
|
||||
- Works with GCC 4.x, GCC 5.x, Clang, Xcode, MSVC 2015, ICC and TCC.
|
||||
- Works on Linux, FreeBSD, OS X, iOS and Windows.
|
||||
- The only dependency is on `zlib`.
|
||||
|
||||
|
@ -39,7 +39,7 @@ The first step is to include the header for the library:
|
||||
@skipline include
|
||||
|
||||
Then we need some data to add to the spreadsheet. For the sake of this example
|
||||
we create and initialise some simple data structures. In a real application
|
||||
we create and initialize some simple data structures. In a real application
|
||||
the input data might come from a database or a file.
|
||||
|
||||
@dontinclude tutorial1.c
|
||||
|
@ -38,7 +38,7 @@ The members of the lxw_datetime struct and the range of their values are:
|
||||
Dates in Excel do not support timezones and the maximum resolution of times is
|
||||
milliseconds.
|
||||
|
||||
If dates or times are required without the other you should initialise the
|
||||
If dates or times are required without the other you should initialize the
|
||||
unrequired values to `0`:
|
||||
|
||||
@code
|
||||
|
@ -28,7 +28,7 @@ If required, this memory usage can be reduced even more by setting
|
||||
maximum column that is likely to be encountered.
|
||||
|
||||
The trade-off when using `constant_memory` mode is that data must be added
|
||||
sequentiallly in row order and you won't be able to take advantage of any new
|
||||
sequentially in row order and you won't be able to take advantage of any new
|
||||
features that manipulate cell data after it is written. Currently the only
|
||||
such feature is worksheet_set_row() which in `constant_memory` mode can only
|
||||
be used when writing data to the current row.
|
||||
@ -64,7 +64,7 @@ Apple Numbers for Mac where the string data isn't displayed.
|
||||
Performance
|
||||
-----------
|
||||
|
||||
Currently the library isn't optimised. There are some known bottlenecks that
|
||||
Currently the library isn't optimized. There are some known bottlenecks that
|
||||
will be reduced in upcoming versions. Also, the library is currently single
|
||||
threaded.
|
||||
|
||||
|
@ -25,7 +25,7 @@
|
||||
*
|
||||
* @image html formats_intro.png
|
||||
*
|
||||
* Formats in `libxlswriter` are accessed via the lxw_format
|
||||
* Formats in `libxlsxwriter` are accessed via the lxw_format
|
||||
* struct. Throughout this document these will be referred to simply as
|
||||
* *Formats*.
|
||||
*
|
||||
@ -37,7 +37,7 @@
|
||||
* @endcode
|
||||
*
|
||||
* The members of the lxw_format struct aren't modified directly. Instead the
|
||||
* format properties are set by calling the function shown in this section.
|
||||
* format properties are set by calling the functions shown in this section.
|
||||
* For example:
|
||||
*
|
||||
* @code
|
||||
@ -54,7 +54,7 @@
|
||||
* @endcode
|
||||
*
|
||||
* The full range of formatting options that can be applied using
|
||||
* `libxlswriter` are shown below.
|
||||
* `libxlsxwriter` are shown below.
|
||||
*
|
||||
*/
|
||||
#ifndef __LXW_FORMAT_H__
|
||||
@ -68,9 +68,9 @@
|
||||
#include "common.h"
|
||||
|
||||
/**
|
||||
* @brief The type for RGB colors in libxlswriter.
|
||||
* @brief The type for RGB colors in libxlsxwriter.
|
||||
*
|
||||
* The type for RGB colors in libxlswriter. The valid range is `0x000000`
|
||||
* The type for RGB colors in libxlsxwriter. The valid range is `0x000000`
|
||||
* (black) to `0xFFFFFF` (white). See @ref working_with_colors.
|
||||
*/
|
||||
typedef int32_t lxw_color_t;
|
||||
@ -323,7 +323,7 @@ enum lxw_format_borders {
|
||||
/**
|
||||
* @brief Struct to represent the formatting properties of an Excel format.
|
||||
*
|
||||
* Formats in `libxlswriter` are accessed via this struct.
|
||||
* Formats in `libxlsxwriter` are accessed via this struct.
|
||||
*
|
||||
* The members of the lxw_format struct aren't modified directly. Instead the
|
||||
* format properties are set by calling the functions shown in format.h.
|
||||
|
@ -13,7 +13,7 @@
|
||||
#include "xlsxwriter/third_party/queue.h"
|
||||
#include "common.h"
|
||||
|
||||
/* Macro to loop over hash table elements in insertion orfder. */
|
||||
/* Macro to loop over hash table elements in insertion order. */
|
||||
#define LXW_FOREACH_ORDERED(elem, hash_table) \
|
||||
STAILQ_FOREACH((elem), (hash_table)->order_list, lxw_hash_order_pointers)
|
||||
|
||||
|
@ -128,7 +128,7 @@ enum lxw_workbook_error {
|
||||
* * `constant_memory`
|
||||
*/
|
||||
typedef struct lxw_workbook_options {
|
||||
/** Optimise the workbook to use constant memory for worksheets */
|
||||
/** Optimize the workbook to use constant memory for worksheets */
|
||||
uint8_t constant_memory;
|
||||
} lxw_workbook_options;
|
||||
|
||||
|
@ -700,10 +700,10 @@ int8_t worksheet_write_url_opt(lxw_worksheet *worksheet,
|
||||
* and `mailto:` :
|
||||
*
|
||||
* @code
|
||||
* worksheet_write_url(worksheet, 0, 0, "ftp://www.python.org/", url_format);
|
||||
* worksheet_write_url(worksheet, 1, 0, "http://www.python.org/", url_format);
|
||||
* worksheet_write_url(worksheet, 2, 0, "https://www.python.org/", url_format);
|
||||
* worksheet_write_url(worksheet, 3, 0, "mailto:jmcnamaracpan.org", url_format);
|
||||
* worksheet_write_url(worksheet, 0, 0, "ftp://www.python.org/", url_format);
|
||||
* worksheet_write_url(worksheet, 1, 0, "http://www.python.org/", url_format);
|
||||
* worksheet_write_url(worksheet, 2, 0, "https://www.python.org/", url_format);
|
||||
* worksheet_write_url(worksheet, 3, 0, "mailto:jmcnamara@cpan.org", url_format);
|
||||
*
|
||||
* @endcode
|
||||
*
|
||||
@ -1080,7 +1080,7 @@ int8_t worksheet_set_column(lxw_worksheet *worksheet, lxw_col_t first_col,
|
||||
* so that they act as a single area.
|
||||
*
|
||||
* Excel generally merges and centers cells at same time. To get similar
|
||||
* behaviour with libxlsxwriter you need to apply a @ref format.h "Format"
|
||||
* behavior with libxlsxwriter you need to apply a @ref format.h "Format"
|
||||
* object with the appropriate alignment:
|
||||
*
|
||||
* @code
|
||||
@ -1488,7 +1488,7 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
|
||||
* @endcode
|
||||
*
|
||||
* For simple text, if you do not specify any justification the text will be
|
||||
* centred. However, you must prefix the text with `&C` if you specify a font
|
||||
* centered. However, you must prefix the text with `&C` if you specify a font
|
||||
* name or any other formatting:
|
||||
*
|
||||
* @code
|
||||
|
@ -10,7 +10,7 @@
|
||||
* in the Excel XLSX file format.
|
||||
*
|
||||
* This library is used in preference to a more generic XML library to allow
|
||||
* for customisation and optimisation for the XLSX file format.
|
||||
* for customization and optimisation for the XLSX file format.
|
||||
*
|
||||
* The xmlwriter functions are only used internally and do not need to be
|
||||
* called directly by the end user.
|
||||
@ -58,7 +58,7 @@ struct xml_attribute *_new_attribute_str(const char *key, const char *value);
|
||||
struct xml_attribute *_new_attribute_int(const char *key, uint32_t value);
|
||||
struct xml_attribute *_new_attribute_dbl(const char *key, double value);
|
||||
|
||||
/* Macro to initialise the xml_attribute_list pointers. */
|
||||
/* Macro to initialize the xml_attribute_list pointers. */
|
||||
#define _INIT_ATTRIBUTES() \
|
||||
STAILQ_INIT(&attributes)
|
||||
|
||||
|
@ -19,7 +19,7 @@ Pod::Spec.new do |s|
|
||||
* Source code available on [GitHub](https://github.com/jmcnamara/libxlsxwriter).
|
||||
* FreeBSD @ref license.
|
||||
* ANSI C.
|
||||
* Works with GCC 4.x, GCC 5.x, Clang, Xcode, MSVS 2015, ICC and TCC.
|
||||
* Works with GCC 4.x, GCC 5.x, Clang, Xcode, MSVC 2015, ICC and TCC.
|
||||
* Works on Linux, FreeBSD, OS X, iOS and Windows.
|
||||
* The only dependency is on `zlib`.
|
||||
DESC
|
||||
|
Loading…
x
Reference in New Issue
Block a user