add tab-separated (.tsv) format to csv importer
[MojoFacets.git] / README
diff --git a/README b/README
index 0b3ea6b..da01a38 100644 (file)
--- a/README
+++ b/README
@@ -12,6 +12,14 @@ Multi-line values should be wrapped in ^multi-line-text^
 If you save bounch of html files with table in directory with .html extension, they will
 we all read as single data set, allowing easy analysys of search results, for example.
 
 If you save bounch of html files with table in directory with .html extension, they will
 we all read as single data set, allowing easy analysys of search results, for example.
 
+CSV files with .csv extension are parsed using , as delimiter. Encoding is utf8
+and can be specified in filename, before extension like this: data.encoding.csv
+
+CouchDB data can be imported using files which contain full url to CouchDB database
+or url to CouchDB view to import. URL's filename should end in *.couchdb
+
+lsblk .pairs format is basically shell variables in form NAME="value"
+
 
 Start with:
 
 
 Start with:
 
@@ -58,6 +66,10 @@ element from your dataset.
 If you want to create or update values, you will have to use $update hash to set
 new values.
 
 If you want to create or update values, you will have to use $update hash to set
 new values.
 
+If you want to report something from your dataset (also called reduce in map/reduce
+terminology) you can use $out hash to store values which will be used to generate
+new dataset using $key and $value for column names.
+
 All values are repetable, but if you create just a scalar, magic(tm) inside MojoFacets
 will try to upgrade it to [ $scalar ] so you don't have to do it explicitly.
 
 All values are repetable, but if you create just a scalar, magic(tm) inside MojoFacets
 will try to upgrade it to [ $scalar ] so you don't have to do it explicitly.
 
@@ -67,6 +79,12 @@ They use column1,column2.description.pl notatition so only snippets which have a
 column will be shown.
 
 
 column will be shown.
 
 
+Facet code eval:
+
+Code snippet will be executed for each facet $value and will report $count and $checked state.
+You can also update $checked to programatically select part of facet values.
+
+
 Export data:
 
 All exported data is stored in public/export/database/
 Export data:
 
 All exported data is stored in public/export/database/