Docs format update, added reference to PAPA parse

ws-garcia · ws-garcia · commit 6f5c39a59998 · 2020-10-31T17:55:37.000-04:00
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 VBA CSV interface is a class module developed to accomplish the data exchange task between VBA arrays and CSV files at high speed. Projects from [@sdkn104](https://github.com/sdkn104/VBA-CSV) and [@Senipah](https://github.com/Senipah/VBA-Better-Array), both on Github, were used for comparative performance purposes.
 
 The parser is compatible with those CSV files compliant with the RFC-4180 standard, but add some useful features like: 
-* In-line comments (with a user-defined character).
+* In-line comments (with a user-defined character). See [Papa Parse](https://www.papaparse.com/) project.
 * Skip blanks lines and empty ones.
 * User-defined escape character (option not available in _Power Query for Excel 2019_ and with some inconsistences when use the _From Text(Legacy)_ wizard)[[1]](#1).
 
diff --git a/docs/api/enumerations/escapetype.md b/docs/api/enumerations/escapetype.md
@@ -27,7 +27,8 @@ Provides a list of constants for use to configure the char used as escape one.
 
 *variable* = `EscapeType`.*Constant*
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `EscapeType.NullChar` value is used with the`QuotationMode.All` setting to indicates the CSV file does not use any escape char in its whole length. This values combination conduces the CSV file to be parse/write assuming the `FieldsDelimiter` property is enough for the import/export operations.
 >
 >In the case the `FieldsDelimiter` property is not enough for successfully done the import/export operations, the `EscapeType.DoubleQuotes` value would be used for parse/write an CSV having fields to be escaped with double quote and the `EscapeType.Apostrophe` values for parse/write an CSV having fields to be escaped with the apostrophe, using the `QuotationMode.Critical` mode.
diff --git a/docs/api/enumerations/quotationmode.md b/docs/api/enumerations/quotationmode.md
@@ -26,7 +26,8 @@ Provides a list of constants to configure the CSV parsing/writing operation beha
 
 *variable* = `QuotationMode`.*Constant*
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `QuotationMode.Critical` value, default one, is used to indicates the CSV file must use escape char only in fields having special char. The `QuotationMode.All` value most be used for those CSV files in wich all its fields will be escaped with the escape char given with the `EscapeChar` property.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/methods/dumptoarray.md b/docs/api/methods/dumptoarray.md
@@ -25,7 +25,8 @@ The required *OutPutArray* argument is an identifier specifying a dynamic `Strin
 
 _None_
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Before dump data, is recommended to make a `ImportFromCSV` or `ImportFromCSVstring` method call. The *OutPutArray* parameter must be declared as dynamic `String` array. If user forget to do this, an error will occur.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/methods/dumptosheet.md b/docs/api/methods/dumptosheet.md
@@ -49,7 +49,8 @@ Dumps the data from the current instance to an Excel WorkSheet.
 
 _None_
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Before dump data, is recommended to make a `ImportFromCSV` or `ImportFromCSVstring` method call.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/methods/exporttocsv.md b/docs/api/methods/exporttocsv.md
@@ -25,7 +25,8 @@ The required *csvArray* argument is an identifier specifying a `Variant` array v
 
 _None_
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Before invoke the `ExportToCSV` method, the user must to open a connection to the CSV file. The *csvArray* parameter must be declared as `Variant` array. Passing a variable that isn't an array will cause an error and the operation aborts. 
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/methods/getdatafromcsv.md b/docs/api/methods/getdatafromcsv.md
@@ -25,7 +25,8 @@ The required *csvPathAndFilename* argument is an identifier specifying a `String
 
 *Type*: `String`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The *csvPathAndFilename* parameter must be the full path to the target CSV file, this means, the parameter holds the folder path, the file name and the ".csv" extension.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/methods/importfromcsv.md b/docs/api/methods/importfromcsv.md
@@ -42,7 +42,8 @@ Imports a CSV file's content to an array.
 
 _None_
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >If the *HeadersOmission* parameter is set to `True`, the CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1. 
 >The *PassControlToOS* parameter allows user to pass control to the operating system. Control is returned after the operating system has finished processing the events in its queue.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
@@ -56,7 +57,8 @@ See also
 
 User can set `CommentLineIndicator` for those CSV files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the CSV file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
 
->⚠️**Caution:**
+>⚠️**Caution**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Before invoke the `ImportFromCSV` method, the user must to open a connection to the CSV file. If the CSV file has no data, this is the file is an empty one, the `ImportFromCSV` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
 {: .text-grey-dk-300 .bg-yellow-000 }
 
diff --git a/docs/api/methods/importfromcsvstring.md b/docs/api/methods/importfromcsvstring.md
@@ -46,7 +46,8 @@ Parses a string and save its CSV data to an array.
 
 _None_
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >If the *HeadersOmission* parameter is set to `True`, the CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1. 
 >The *PassControlToOS* parameter allows user to pass control to the operating system. Control is returned after the operating system has finished processing the events in its queue.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
@@ -60,7 +61,8 @@ See also
 
 User can set `CommentLineIndicator` for those CSV files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the CSV file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
 
->⚠️**Caution:**
+>⚠️**Caution**
+>{: .text-grey-dk-300 .bg-green-000 }
 >If the CSV file has no data, this is the file is an empty one, the `ImportFromCSVstring` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
 {: .text-grey-dk-300 .bg-yellow-000 }
 
diff --git a/docs/api/methods/openconnection.md b/docs/api/methods/openconnection.md
@@ -42,11 +42,13 @@ Loads a CSV file on memory for data Input/Output operations.
 
 _None_
 
->⚠️**Caution:**
+>⚠️**Caution**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `OpenConnection` method don't rejects any kind of file extension, user need to ensure the target file has a name ending in `.csv` or `.txt`.
 {: .text-grey-dk-300 .bg-yellow-000 }
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `OpenConnection` method is the preamble to the `ImportFromCSV` and `ExportToCSV` methods, this means each call to the citated methods must be preceded by a `OpenConnection` method call.
 >After call the `OpenConnection` method is possible to check if the instance is bind to the CSV file, for which is only needed to read the current instance `Connected` property.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
diff --git a/docs/api/methods/resettodefault.md b/docs/api/methods/resettodefault.md
@@ -25,7 +25,8 @@ _None_
 
 _None_
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Before call the `ResetToDefault` method, user must to check if the target CSV will be well parsed with the config options shown in the table below.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/commentlineindicator.md b/docs/api/properties/commentlineindicator.md
@@ -39,11 +39,13 @@ _Yes_
 |Get|`String`|
 |Let|_None_|
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >A line starting with the `CommentLineIndicator` char is expected to be automatic ignored by the parser. By default, the char "#" is used for indicate commented lines, but this property can be set to whatever character. If the `CommentLineIndicator` has a length greater than 1, only the first char of it is used.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
->⚠️**Caution:**
+>⚠️**Caution**
+>{: .text-grey-dk-300 .bg-green-000 }
 >This property is only used when the `QuotingMode` property is set to `QuotationMode.Critical`.
 {: .text-grey-dk-300 .bg-yellow-000 }
 
diff --git a/docs/api/properties/connected.md b/docs/api/properties/connected.md
@@ -31,7 +31,8 @@ _None_
 
 *Type*: `Boolean`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >A `False` value from `Connected` property indicates the CSV file is not load in memory.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/endingrecord.md b/docs/api/properties/endingrecord.md
@@ -36,7 +36,8 @@ _Yes_
 |Get|`Long`|
 |Let|_None_|
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `EndingRecord` property must be used in combination with the `StartingRecord` property for import a certain range of records from a CSV file.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/errdescription.md b/docs/api/properties/errdescription.md
@@ -31,7 +31,8 @@ _None_
 
 *Type*: `String`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Use the `ErrDescription` property to check if the last requested operation succeed.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/errnumber.md b/docs/api/properties/errnumber.md
@@ -33,7 +33,8 @@ _None_
 
 *Type*: `Long`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Use the `ErrNumber` property to check if the last requested operation succeed.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/errsource.md b/docs/api/properties/errsource.md
@@ -31,7 +31,8 @@ _None_
 
 *Type*: `String`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Use the `ErrSource` property to check if the last requested operation succeed.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/escapechar.md b/docs/api/properties/escapechar.md
@@ -36,7 +36,8 @@ _Yes_
 |Get|`EscapeType`/`Long`|
 |Let|_None_|
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Setting the `EscapeChar` property to `EscapeType.NullChar` is only recommended when the `QuotingMode` property is set to `QuotationMode.All`. This scenario comes to reality when user have to work with CSV files over which neither fields need to be escaped.
 >
 >The above means if the target CSV have an unknown structure, the best alternative is set the `EscapeChar` property to `EscapeType.DoubleQuotes` and the `QuotingMode` property to `QuotationMode.Critical`. These are the defaults settings.
diff --git a/docs/api/properties/exportsuccess.md b/docs/api/properties/exportsuccess.md
@@ -31,7 +31,8 @@ _None_
 
 *Type*: `Boolean`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >A `False` value from `ExportSuccess` property indicates the last export operation wouldn't succeeded.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/fieldsdelimiter.md b/docs/api/properties/fieldsdelimiter.md
@@ -36,7 +36,8 @@ _Yes_
 |Get|`String`|
 |Let|_None_|
 
->⚠️**Caution:**
+>⚠️**Caution**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The current behavior for the CSV interface forces `FieldsDelimiter` property to be distinct than a `Space` or`vbTab` char, set the property to comma or semicolon are the most logical options.
 {: .text-grey-dk-300 .bg-yellow-000 }
 
diff --git a/docs/api/properties/fileencoding.md b/docs/api/properties/fileencoding.md
@@ -31,7 +31,8 @@ _None_
 
 *Type*: `String`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `FileEncoding` property is set when CSV file is load on memory. In other words, the property holds the encoding for the last opened file. All the possible values are shown in this section.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -66,7 +67,8 @@ _None_
 </tbody>
 </table>
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Since VBA works with Unicode charset, a check to the `FileEncoding` property can help user overcome some codification issues. For this purposes, out there are free tools like [Notepad++](https://npp-user-manual.org/preferences/) with options to change a file codification with just a left mouse click.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/filename.md b/docs/api/properties/filename.md
@@ -31,7 +31,8 @@ _None_
 
 *Type*: `String`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `fileName` property is set when CSV file is load to memory. This is, the property holds the last opened file’s name.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/importsuccess.md b/docs/api/properties/importsuccess.md
@@ -31,7 +31,8 @@ _None_
 
 *Type*: `Boolean`
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >A `False` value from `ImportSuccess` property indicates the last import operation wouldn't succeeded.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/quotingmode.md b/docs/api/properties/quotingmode.md
@@ -36,7 +36,8 @@ _Yes_
 |Get|`QuotationMode`/`Long`|
 |Let|_None_|
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Use the `QuotingMode` property to set the parser behavior. Some CSV files not require further processes after an easy to do string split.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/recordsdelimiter.md b/docs/api/properties/recordsdelimiter.md
@@ -36,7 +36,8 @@ _Yes_
 |Get|`String`|
 |Let|_None_|
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >The `RecordsDelimiter` property can be set to`vbCr`, `vbCrLf` or `vbLf`. This options unlocks a limitation from RFC-4180 CSV standard .
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/api/properties/startingrecord.md b/docs/api/properties/startingrecord.md
@@ -36,7 +36,8 @@ _Yes_
 |Get|`Long`|
 |Let|_None_|
 
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >Use the `StartingRecord` property in combination with the `EndingRecord` property for import a certain range of records from CSV file.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/examples/exportation-examples.md b/docs/examples/exportation-examples.md
@@ -21,7 +21,8 @@ nav_order: 2
 The [EXAMPLE1] shows how you can export all the data in VBA array to a CSV file using the RFC-4180 standard as paramount. 
 
 #### [EXAMPLE1]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.Critical`, [learn more here](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html).
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -56,7 +57,8 @@ See also
 :[QuotationMode](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html), [EscapeType](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/escapetype.html).
 
 #### [EXAMPLE2]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.All`, and `EscapeType.NullChar`.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -90,7 +92,8 @@ See also
 :[QuotationMode](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html), [EscapeType](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/escapetype.html).
 
 #### [EXAMPLE3]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.All`, and `EscapeType.NullChar`.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/examples/importation-examples.md b/docs/examples/importation-examples.md
@@ -21,7 +21,8 @@ nav_order: 1
 The [EXAMPLE1] shows how you can import all the data from a CSV file using the RFC-4180 standard as paramount. 
 
 #### [EXAMPLE1]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.Critical`, [learn more here](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html).
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -45,7 +46,8 @@ End Sub
 The [EXAMPLE2] shows how you can import the Top 10 records from a CSV file using the RFC-4180 standard as paramount.
 
 #### [EXAMPLE2]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.Critical`, [learn more here](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html).
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -67,7 +69,8 @@ End Sub
 The [EXAMPLE3] accomplishes the same task of the [EXAMPLE1], the difference is that a temporary variable is used to store the CSV file's content instead of use the `OpenConnection` method. Also, the [EXAMPLE3] shows how to omit the CSV's headers.
 
 #### [EXAMPLE3]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.Critical`, [learn more here](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html).
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -91,7 +94,8 @@ End Sub
 The [EXAMPLE4] shows how you can import 10 middle records from a CSV file using the RFC-4180 standard as paramount.
 
 #### [EXAMPLE4]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.Critical`, [learn more here](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html).
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -121,7 +125,8 @@ The [EXAMPLE5] shows how you can import all the data from a CSV file without che
 See also
 :[QuotationMode](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html), [EscapeType](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/escapetype.html).
 #### [EXAMPLE5]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.All`, and `EscapeType.NullChar`.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
@@ -161,7 +166,8 @@ The [EXAMPLE7] shows how you can import all the data from a CSV file without che
 See also
 :[QuotationMode](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/quotationmode.html), [EscapeType](https://ws-garcia.github.io/VBA-CSV-interface/api/enumerations/escapetype.html).
 #### [EXAMPLE7]
->📝**Note:**
+>📝**Note**
+>{: .text-grey-dk-300 .bg-green-000 }
 >the example uses the option `QuotationMode.All`, and `EscapeType.DoubleQuotes`.
 {: .text-grey-dk-300 .bg-grey-lt-000 }
 
diff --git a/docs/home/getting_started.md b/docs/home/getting_started.md
diff --git a/docs/home/installation.md b/docs/home/installation.md
diff --git a/docs/index.md b/docs/index.md

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,8 @@ Provides a list of constants for use to configure the char used as escape one.`
`27`	`27`
`28`	`28`	variable = `EscapeType`.Constant
`29`	`29`
`30`		`->📝Note:`
	`30`	`+>📝Note`
	`31`	`+>{: .text-grey-dk-300 .bg-green-000 }`
`31`	`32`	>The `EscapeType.NullChar` value is used with the`QuotationMode.All` setting to indicates the CSV file does not use any escape char in its whole length. This values combination conduces the CSV file to be parse/write assuming the `FieldsDelimiter` property is enough for the import/export operations.
`32`	`33`	`>`
`33`	`34`	>In the case the `FieldsDelimiter` property is not enough for successfully done the import/export operations, the `EscapeType.DoubleQuotes` value would be used for parse/write an CSV having fields to be escaped with double quote and the `EscapeType.Apostrophe` values for parse/write an CSV having fields to be escaped with the apostrophe, using the `QuotationMode.Critical` mode.