diff --git a/README.md b/README.md index 4730815..3648d8b 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ Or install it yourself as: * [Introduction](docs/_introduction.md) * [The Basic API](docs/basic_api.md) + * [Batch Processing](./docs/batch_processing.md) * [Configuration Options](docs/options.md) * [Row and Column Separators](docs/row_col_sep.md) * [Header Transformations](docs/header_transformations.md) diff --git a/docs/_introduction.md b/docs/_introduction.md index a564a46..d0d2ed1 100644 --- a/docs/_introduction.md +++ b/docs/_introduction.md @@ -1,3 +1,5 @@ +PREVIOUS [README](../README.md) | NEXT: [The Basic API](./basic_api.md) +--------------- # SmarterCSV Introduction @@ -39,4 +41,5 @@ The CSV processing also needed to be robust against variations in the input data * Data Validations (planned feature) +--------------- PREVIOUS [README](../README.md) | NEXT: [The Basic API](./basic_api.md) diff --git a/docs/basic_api.md b/docs/basic_api.md index 453d19f..61a9496 100644 --- a/docs/basic_api.md +++ b/docs/basic_api.md @@ -1,3 +1,5 @@ +PREVIOUS: [Introduction](./_introduction.md) | NEXT: [Batch Processing](./batch_processing.md) +---------------- # SmarterCSV API @@ -139,4 +141,5 @@ $ hexdump -C spec/fixtures/bom_test_feff.csv end ``` -PREVIOUS: [Introduction](./_introduction.md) | NEXT: [Configuration Options](./options.md) +---------------- +PREVIOUS: [Introduction](./_introduction.md) | NEXT: [Batch Processing](./batch_processing.md) diff --git a/docs/batch_processing.md b/docs/batch_processing.md index 3c20d3c..a5e0414 100644 --- a/docs/batch_processing.md +++ b/docs/batch_processing.md @@ -1,3 +1,5 @@ +PREVIOUS: [The Basic API](./basic_api.md) | NEXT: [Configuration Options](./options.md) +---------------- # Batch Processing @@ -50,4 +52,5 @@ and how the `process` method returns the number of chunks when called with a blo => returns number of chunks we processed ``` - +---------------- +PREVIOUS: [The Basic API](./basic_api.md) | NEXT: [Configuration Options](./options.md) diff --git a/docs/data_transformations.md b/docs/data_transformations.md index b94a38f..62416e8 100644 --- a/docs/data_transformations.md +++ b/docs/data_transformations.md @@ -1,3 +1,6 @@ +PREVIOUS: [Header Validations](./header_validations.md) | NEXT: [Value Converters](./value_converters.md) +------------------- + # Data Transformations SmarterCSV automatically transforms the values in each colum in order to normalize the data. @@ -31,4 +34,5 @@ By default SmarterCSV uses `remove_empty_hashes: true` to remove these empty has This can be set to `true`, to keep these empty hashes in the results. +------------------- PREVIOUS: [Header Validations](./header_validations.md) | NEXT: [Value Converters](./value_converters.md) diff --git a/docs/header_transformations.md b/docs/header_transformations.md index 933549d..fabe757 100644 --- a/docs/header_transformations.md +++ b/docs/header_transformations.md @@ -1,3 +1,6 @@ +PREVIOUS: [Row and Column Separators](./row_col_sep.md) | NEXT: [Header Validations](./header_validations.md) +--------------- + # Header Transformations By default SmarterCSV assumes that a CSV file has headers, and it automatically normalizes the headers and transforms them into Ruby symbols. You can completely customize or override this (see below). @@ -93,6 +96,6 @@ For CSV files with headers, you can either: * some CSV files use un-escaped quotation characters inside fields. This can cause the import to break. To get around this, use the `:force_simple_split => true` option in combination with `:strip_chars_from_headers => /[\-"]/` . This will also significantly speed up the import. If you would force a different :quote_char instead (setting it to a non-used character), then the import would be up to 5-times slower than using `:force_simple_split`. - +--------------- PREVIOUS: [Row and Column Separators](./row_col_sep.md) | NEXT: [Header Validations](./header_validations.md) diff --git a/docs/header_validations.md b/docs/header_validations.md index 09a6d2e..500bf86 100644 --- a/docs/header_validations.md +++ b/docs/header_validations.md @@ -1,3 +1,6 @@ +PREVIOUS: [Header Transformations](./header_transformations.md) | NEXT: [Data Transformations](./data_transformations.md) +---------------- + # Header Validations When you are importing data, it can be important to verify that all required data is present, to ensure consistent quality when importing data. @@ -17,4 +20,5 @@ If these keys are not present, `SmarterCSV::MissingKeys` will be raised to infor => this will raise SmarterCSV::MissingKeys if any row does not contain these three keys ``` +---------------- PREVIOUS: [Header Transformations](./header_transformations.md) | NEXT: [Data Transformations](./data_transformations.md) diff --git a/docs/options.md b/docs/options.md index 91bea56..8643713 100644 --- a/docs/options.md +++ b/docs/options.md @@ -1,3 +1,5 @@ +PREVIOUS: [Batch Processing](./batch_processing.md) | NEXT: [Row and Column Separators](./row_col_sep.md) +------------- # SmarterCSV Options @@ -80,7 +82,5 @@ There have been a lot of 1-offs and feature creep around these options, and goin | | | also accepts either {:except => [:key1,:key2]} or {:only => :key3} | --------------------------------------------------------------------------------------------------------------------------------- - -PREVIOUS: [The Basic API](./basic_api.md) | NEXT: [Row and Column Separators](./row_col_sep.md) - - +------------- +PREVIOUS: [Batch Processing](./batch_processing.md) | NEXT: [Row and Column Separators](./row_col_sep.md) diff --git a/docs/row_col_sep.md b/docs/row_col_sep.md index e6fbc23..c3b3a94 100644 --- a/docs/row_col_sep.md +++ b/docs/row_col_sep.md @@ -1,3 +1,5 @@ +PREVIOUS: [Configuration Options](./options.md) | NEXT: [Header Transformations](./header_transformations.md) +---------------- # Row and Column Separators @@ -86,4 +88,5 @@ In this example, we use `comment_regexp` to filter out and ignore any lines star => returns number of chunks ``` +---------------- PREVIOUS: [Configuration Options](./options.md) | NEXT: [Header Transformations](./header_transformations.md) diff --git a/docs/value_converters.md b/docs/value_converters.md index a0c7cb4..7c4ebcf 100644 --- a/docs/value_converters.md +++ b/docs/value_converters.md @@ -1,3 +1,5 @@ +PREVIOUS: [Data Transformations](./data_transformations.md) | UP: [README](../README.md) +-------------------- # Using Value Converters @@ -50,4 +52,5 @@ If you use `key_mappings` and `value_converters`, make sure that the value conve => Float ``` +-------------------- PREVIOUS: [Data Transformations](./data_transformations.md) | UP: [README](../README.md)