re-organize docs and examples

Author: rsdoiel

docs/csv2json/index.md

@@ -0,0 +1,44 @@
+
+# USAGE
+
+	csv2json [OPTIONS]
+
+## SYNOPSIS
+
+
+csv2json reads CSV from stdin and writes a JSON to stdout. JSON output
+can be either an array of JSON blobs or one JSON blob (row as object)
+per line.
+
+
+## OPTIONS
+
+```
+    -as-blobs                 output as one JSON blob per line
+    -d, -delimiter            set the delimter character
+    -examples                 display example(s)
+    -generate-markdown-docs   generation markdown documentation
+    -h, -help                 display help
+    -i, -input                input filename
+    -l, -license              display license
+    -nl, -newline             include trailing newline in output
+    -o, -output               output filename
+    -quiet                    suppress error output
+    -use-header               treat the first row as field names
+    -v, -version              display version
+```
+
+
+## EXAMPLES
+
+
+Convert data1.csv to data1.json using Unix pipes.
+
+    cat data1.csv | csv2json > data1.json
+
+Convert data1.csv to JSON blobs, one line per blob
+
+    csv2json -as-blobs -i data1.csv
+
+
+csv2json v0.0.20-pre

docs/csv2json/nav.md

@@ -0,0 +1,6 @@
++ [Home](/)
++ [README](../../index.html)
++ [Documentation](../../docs/)
++ [How To](../../how-to/)
++ [Installation](../../INSTALL.html)
++ [Github](https://github.com/caltechlibrary/datatools)

docs/csv2mdtable/index.md

@@ -0,0 +1,41 @@
+
+# USAGE
+
+	csv2mdtable [OPTIONS]
+
+## SYNOPSIS
+
+
+csv2mdtable reads CSV from stdin and writes a Github Flavored Markdown
+table to stdout.
+
+
+## OPTIONS
+
+```
+    -d, -delimiter            set delimiter character
+    -examples                 display example(s)
+    -generate-markdown-docs   generate markdown documentation
+    -h, -help                 display help
+    -i, -input                input filename
+    -l, -license              display license
+    -nl, -newline             if true include leading/trailing newline
+    -o, -output               output filename
+    -quiet                    suppress error message
+    -v, -version              display version
+```
+
+
+## EXAMPLES
+
+
+Convert data1.csv to data1.md using Unix pipes.
+
+    cat data1.csv | csv2mdtable > data1.md
+
+Convert data1.csv to data1.md using options.
+
+    csv2mdtable -i data1.csv -o data1.md
+
+
+csv2mdtable v0.0.20-pre

docs/csv2mdtable/nav.md

@@ -0,0 +1,6 @@
++ [Home](/)
++ [README](../../index.html)
++ [Documentation](../../docs/)
++ [How To](../../how-to/)
++ [Installation](../../INSTALL.html)
++ [Github](https://github.com/caltechlibrary/datatools)

docs/csv2xlsx/index.md

@@ -0,0 +1,46 @@
+
+# USAGE
+
+	csv2xlsx [OPTIONS] WORKBOOK_NAME SHEET_NAME
+
+## SYNOPSIS
+
+
+csv2xlsx will take CSV input and create a new sheet in an Excel Workbook.
+If the Workbook does not exist then it is created.
+
+
+## OPTIONS
+
+```
+    -d, -delimiter            set delimiter character (input)
+    -examples                 display example(s)
+    -generate-markdown-docs   generate markdown documentation
+    -h, -help                 display help
+    -i, -input                input filename (CSV content)
+    -l, -license              display license
+    -o, -output               output filename
+    -quiet                    suppress error messages
+    -sheet                    Sheet name to create/replace
+    -v, -version              display version
+    -workbook                 Workbook name
+```
+
+
+## EXAMPLES
+
+
+Converting a csv to a workbook.
+
+	csv2xlsx -i data.csv MyWorkbook.xlsx 'My worksheet 1'
+
+This creates a new 'My worksheet 1' in the Excel Workbook
+called 'MyWorkbook.xlsx' with the contents of data.csv.
+
+	cat data.csv | csv2xlsx MyWorkbook.xlsx 'My worksheet 2'
+
+This does the same but the contents of data.csv are piped into
+the workbook's 'My worksheet 2' sheet.
+%!(EXTRA string=csv2xlsx, string=csv2xlsx)
+
+csv2xlsx v0.0.20-pre

docs/csv2xlsx/nav.md

@@ -0,0 +1,6 @@
++ [Home](/)
++ [README](../../index.html)
++ [Documentation](../../docs/)
++ [How To](../../how-to/)
++ [Installation](../../INSTALL.html)
++ [Github](https://github.com/caltechlibrary/datatools)

docs/csvcleaner/index.md

@@ -0,0 +1,65 @@
+
+# USAGE
+
+	csvcleaner [OPTIONS]
+
+## SYNOPSIS
+
+
+csvcleaner normalizes a CSV file based on the options selected. It
+helps to address issues like variable number of columns, leading/trailing
+spaces in columns, and non-UTF-8 encoding issues.
+
+By default input is expected from standard in and output is sent to 
+standard out (errors to standard error). These can be modified by
+appropriate options. The csv file is processed as a stream of rows so 
+minimal memory is used to operate on the file. 
+
+
+## OPTIONS
+
+```
+    -V, -verbose              write verbose output to standard error
+    -comma                    if set use this character in place of a comma for delimiting cells
+    -comment-char             if set, rows starting with this character will be ignored as comments
+    -examples                 display example(s)
+    -fields-per-row           set the number of columns to output right padding empty cells as needed
+    -generate-markdown-docs   generation markdown documentation
+    -h, -help                 display help
+    -i, -input                input filename
+    -l, -license              display license
+    -left-trim                If set to true leading white space in a field is ignored.
+    -o, -output               output filename
+    -output-comma             if set use this character in place of a comma for delimiting output cells
+    -quiet                    suppress error messages
+    -reuse                    if false then a new array is allocated for each row processed, if true the array gets reused
+    -right-trim               If set to true trailing white space in a field is ignored.
+    -stop-on-error            exit on error, useful if you're trying to debug a problematic CSV file
+    -trim                     If set to true leading and trailing white space in a field is ignored.
+    -use-crlf                 if set use a charage return and line feed in output
+    -use-lazy-quoting         If LazyQuotes is true, a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field.
+    -v, -version              display version
+```
+
+
+## EXAMPLES
+
+
+Normalizing a spread sheet's column count to 5 padding columns as needed per row.
+
+    cat mysheet.csv | csvcleaner -field-per-row=5
+
+Trim leading spaces.
+
+    cat mysheet.csv | csvcleaner -left-trim
+
+Trim trailing spaces.
+
+    cat mysheet.csv | csvcleaner -right-trim
+
+Trim leading and trailing spaces
+
+    cat mysheet.csv | csvcleaner -trim
+
+
+csvcleaner v0.0.20-pre

docs/csvcleaner/nav.md

@@ -0,0 +1,6 @@
++ [Home](/)
++ [README](../../index.html)
++ [Documentation](../../docs/)
++ [How To](../../how-to/)
++ [Installation](../../INSTALL.html)
++ [Github](https://github.com/caltechlibrary/datatools)

docs/csvcols/index.md

@@ -0,0 +1,57 @@
+
+# USAGE
+
+	csvcols [OPTIONS] [ARGS_AS_COL_VALUES]
+
+## SYNOPSIS
+
+
+csvcols converts a set of command line args into columns output in CSV format.
+It can also be used CSV input rows and rendering only the column numbers
+listed on the commandline (first column is 1 not 0).
+
+
+## OPTIONS
+
+```
+    -col, -cols              output specified columns (e.g. -col 1,12:14,2,4))
+    -d, -delimiter           set the input delimiter character
+    -examples                display example
+    -generate-markdown-docs  generate markdown documentation
+    -h, -help                display help
+    -i, -input               input filename
+    -l, -license             display license
+    -o, -output              output filename
+    -od, -output-delimiter   set the output delimiter character
+    -quiet                   suppress error messages
+    -skip-header-row         skip the header row
+    -uuid                    add a prefix row with generated UUID cell
+    -v, -version             display version
+```
+
+
+## EXAMPLES
+
+
+Simple usage of building a CSV file one row at a time.
+
+    csvcols one two three > 3col.csv
+    csvcols 1 2 3 >> 3col.csv
+    cat 3col.csv
+
+Example parsing a pipe delimited string into a CSV line
+
+    csvcols -d "|" "one|two|three" > 3col.csv
+    csvcols -delimiter "|" "1|2|3" >> 3col.csv
+    cat 3col.csv
+
+Using a pipe filter a 3 column CSV for columns 1 and 3 into 2col.csv
+
+    cat 3col.csv | csvcols -col 1,3 > 2col.csv
+
+Using options filter a 3 column CSV file for columns 1,3 into 2col.csv
+
+    csvcols -i 3col.csv -col 1,3 -o 2col.csv
+
+
+csvcols v0.0.20-pre

docs/csvcols/nav.md

@@ -0,0 +1,6 @@
++ [Home](/)
++ [README](../../index.html)
++ [Documentation](../../docs/)
++ [How To](../../how-to/)
++ [Installation](../../INSTALL.html)
++ [Github](https://github.com/caltechlibrary/datatools)