From 5024854a94661346829601875fee227ab8f1973b Mon Sep 17 00:00:00 2001 From: John McNamara Date: Sun, 23 Jun 2024 12:00:02 +0100 Subject: [PATCH] docs: fix minor issues in data_validate example Closes #449 --- Readme.md | 2 +- dev/release/fix_example_docs.pl | 2 +- docs/src/mainpage.dox | 2 +- docs/src/working_with_data_validation.dox | 6 +++--- examples/data_validate.c | 22 +++++++++++----------- include/xlsxwriter/worksheet.h | 4 ++-- libxlsxwriter.podspec | 2 +- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Readme.md b/Readme.md index d5ab8a4b..4c044110 100644 --- a/Readme.md +++ b/Readme.md @@ -20,7 +20,7 @@ It supports features such as: - Defined names. - Autofilters. - Charts. -- Data validation and drop down lists. +- Data validation and dropdown lists. - Conditional formatting. - Worksheet PNG/JPEG/GIF images. - Cell comments. diff --git a/dev/release/fix_example_docs.pl b/dev/release/fix_example_docs.pl index 5eb305cd..da0f89da 100644 --- a/dev/release/fix_example_docs.pl +++ b/dev/release/fix_example_docs.pl @@ -35,7 +35,7 @@ my @examples = ( [ 'merge_range.c', 'Create a merged range of cells' ], [ 'merge_rich_string.c', 'Create a merged range with a rich string' ], [ 'autofilter.c', 'An example of a worksheet autofilter' ], - [ 'data_validate.c', 'Examples of worksheet data validation and drop down lists' ], + [ 'data_validate.c', 'Examples of worksheet data validation and dropdown lists' ], [ 'conditional_format1.c', 'A simple conditional formatting example' ], [ 'conditional_format2.c', 'An advanced conditional formatting example' ], [ 'tables.c', 'Example of table to a worksheet.' ], diff --git a/docs/src/mainpage.dox b/docs/src/mainpage.dox index 1e5e681f..b23ed717 100644 --- a/docs/src/mainpage.dox +++ b/docs/src/mainpage.dox @@ -19,7 +19,7 @@ features such as: - Defined names. - Autofilters. - Charts. -- Data validation and drop down lists. +- Data validation and dropdown lists. - Conditional formatting. - Worksheet PNG/JPEG/GIF images. - Cell comments. diff --git a/docs/src/working_with_data_validation.dox b/docs/src/working_with_data_validation.dox index 6335051c..a1d0fc6e 100644 --- a/docs/src/working_with_data_validation.dox +++ b/docs/src/working_with_data_validation.dox @@ -250,7 +250,7 @@ criteria is applied using a cell reference. It is valid for any of the `value_list`: -The `value_list` parameter is used to set a list of strings for a drop down +The `value_list` parameter is used to set a list of strings for a dropdown list. The list should be a `NULL` terminated array of char* strings: @code @@ -457,13 +457,13 @@ set using `error_message`. It is on by default. data_validation->minimum_number = 0.1; data_validation->maximum_number = 0.5; - // Select a value from a drop down list. + // Select a value from a dropdown list. char *list[] = {"open", "high", "close", NULL}; data_validation->validate = LXW_VALIDATION_TYPE_LIST; data_validation->value_list = list; - // Select a value from a drop down list (using a cell range). + // Select a value from a dropdown list (using a cell range). data_validation->validate = LXW_VALIDATION_TYPE_LIST; data_validation->value_formula = "=$E$4:$G$4"; diff --git a/examples/data_validate.c b/examples/data_validate.c index 6a269dab..98b48e5d 100644 --- a/examples/data_validate.c +++ b/examples/data_validate.c @@ -4,7 +4,7 @@ * * Data validation is a feature of Excel which allows you to restrict the data * that a user enters in a cell and to display help and warning messages. It - * also allows you to restrict input to values in a drop down list. + * also allows you to restrict input to values in a dropdown list. * * Copyright 2014-2021, John McNamara, jmcnamara@cpan.org */ @@ -28,7 +28,7 @@ void write_worksheet_data(lxw_worksheet *worksheet, lxw_format *format) { worksheet_write_number(worksheet, CELL("E3"), 1, NULL); worksheet_write_number(worksheet, CELL("F3"), 10, NULL); - worksheet_write_string(worksheet, CELL("D4"), "List Data", NULL); + worksheet_write_string(worksheet, CELL("D4"), "List data", NULL); worksheet_write_string(worksheet, CELL("E4"), "open", NULL); worksheet_write_string(worksheet, CELL("F4"), "high", NULL); worksheet_write_string(worksheet, CELL("G4"), "close", NULL); @@ -45,7 +45,7 @@ void write_worksheet_data(lxw_worksheet *worksheet, lxw_format *format) { */ int main() { - lxw_workbook *workbook = workbook_new("data_validate1.xlsx"); + lxw_workbook *workbook = workbook_new("data_validate.xlsx"); lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL); lxw_data_validation *data_validation = (lxw_data_validation *)calloc(1, sizeof(lxw_data_validation)); @@ -90,10 +90,10 @@ int main() { */ worksheet_write_string(worksheet, CELL("A5"), - "Enter an integer not between 1 and 10 (using cell references)", + "Enter an integer that is not between 1 and 10 (using cell references)", NULL); - data_validation->validate = LXW_VALIDATION_TYPE_INTEGER; + data_validation->validate = LXW_VALIDATION_TYPE_INTEGER_FORMULA; data_validation->criteria = LXW_VALIDATION_CRITERIA_NOT_BETWEEN; data_validation->minimum_formula = "=E3"; data_validation->maximum_formula = "=F3"; @@ -152,7 +152,7 @@ int main() { */ worksheet_write_string(worksheet, CELL("A13"), - "Select a value from a drop down list", + "Select a value from a dropdown list", NULL); const char *list[] = {"open", "high", "close", NULL}; @@ -168,7 +168,7 @@ int main() { */ worksheet_write_string(worksheet, CELL("A15"), - "Select a value from a drop down list (using a cell range)", + "Select a value from a dropdown list (using a cell range)", NULL); data_validation->validate = LXW_VALIDATION_TYPE_LIST_FORMULA; @@ -182,11 +182,11 @@ int main() { */ worksheet_write_string(worksheet, CELL("A17"), - "Enter a date between 1/1/2008 and 12/12/2008", + "Enter a date between 1/1/2024 and 12/12/2024", NULL); - lxw_datetime datetime1 = {2008, 1, 1, 0, 0, 0}; - lxw_datetime datetime2 = {2008, 12, 12, 0, 0, 0}; + lxw_datetime datetime1 = {2024, 1, 1, 0, 0, 0}; + lxw_datetime datetime2 = {2024, 12, 12, 0, 0, 0}; data_validation->validate = LXW_VALIDATION_TYPE_DATE; data_validation->criteria = LXW_VALIDATION_CRITERIA_BETWEEN; @@ -207,7 +207,7 @@ int main() { lxw_datetime datetime3 = {0, 0, 0, 6, 0, 0}; lxw_datetime datetime4 = {0, 0, 0, 12, 0, 0}; - data_validation->validate = LXW_VALIDATION_TYPE_DATE; + data_validation->validate = LXW_VALIDATION_TYPE_TIME; data_validation->criteria = LXW_VALIDATION_CRITERIA_BETWEEN; data_validation->minimum_datetime = datetime3; data_validation->maximum_datetime = datetime4; diff --git a/include/xlsxwriter/worksheet.h b/include/xlsxwriter/worksheet.h index ded243a8..01aa3f45 100644 --- a/include/xlsxwriter/worksheet.h +++ b/include/xlsxwriter/worksheet.h @@ -983,7 +983,7 @@ typedef struct lxw_data_validation { const char *value_formula; /** - * This parameter is used to set a list of strings for a drop down list. + * This parameter is used to set a list of strings for a dropdown list. * The list should be a `NULL` terminated array of char* strings: * * @code @@ -3996,7 +3996,7 @@ lxw_error worksheet_merge_range(lxw_worksheet *worksheet, lxw_row_t first_row, * The `%worksheet_autofilter()` function allows an autofilter to be added to * a worksheet. * - * An autofilter is a way of adding drop down lists to the headers of a 2D + * An autofilter is a way of adding dropdown lists to the headers of a 2D * range of worksheet data. This allows users to filter the data based on * simple criteria so that some data is shown and some is hidden. * diff --git a/libxlsxwriter.podspec b/libxlsxwriter.podspec index 6e0f8f7d..e1520054 100644 --- a/libxlsxwriter.podspec +++ b/libxlsxwriter.podspec @@ -16,7 +16,7 @@ Pod::Spec.new do |s| * Defined names. * Autofilters. * Charts. - * Data validation and drop down lists. + * Data validation and dropdown lists. * Conditional formatting. * Worksheet PNG/JPEG/GIF images. * Cell comments.